OpenSearch/rest-api-spec/api/indices.validate_query.json

{
  "indices.validate_query": {
    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html",
    "methods": ["GET", "POST"],
    "url": {
      "path": "/_validate/query",
      "paths": ["/_validate/query", "/{index}/_validate/query", "/{index}/{type}/_validate/query"],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"
        },
        "type": {
          "type" : "list",
          "description" : "A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types"
        }
      },
      "params": {
        "explain": {
          "type" : "boolean",
          "description" : "Return detailed information about the error"
        },
        "ignore_unavailable": {
            "type" : "boolean",
            "description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
        },
        "allow_no_indices": {
            "type" : "boolean",
            "description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
        },
        "expand_wildcards": {
            "type" : "enum",
            "options" : ["open","closed","none","all"],
            "default" : "open",
            "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
        },
        "operation_threading": {
          "description" : "TODO: ?"
        },
        "q": {
          "type" : "string",
          "description" : "Query in the Lucene query string syntax"
        },
        "analyzer": {
          "type" : "string",
          "description" : "The analyzer to use for the query string"
        },
        "analyze_wildcard": {
          "type" : "boolean",
          "description" : "Specify whether wildcard and prefix queries should be analyzed (default: false)"
        },
        "default_operator": {
          "type" : "enum",
          "options" : ["AND","OR"],
          "default" : "OR",
          "description" : "The default operator for query string query (AND or OR)"
        },
        "df": {
          "type" : "string",
          "description" : "The field to use as default where no field prefix is given in the query string"
        },
        "lenient": {
          "type" : "boolean",
          "description" : "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"
        },
        "lowercase_expanded_terms": {
          "type" : "boolean",
          "description" : "Specify whether query terms should be lowercased"
        },
        "rewrite": {
          "type": "boolean",
          "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed."
        }
      }
    },
    "body": {
      "description" : "The query definition specified with the Query DSL"
    }
  }
}