OpenSearch/rest-api-spec/api/indices.validate.query.json

43 lines
1.4 KiB
JSON

{
"indices.validate.query": {
"documentation": "http://www.elasticsearch.org/guide/reference/api/validate/",
"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_indices": {
"type" : "enum",
"options" : ["none","missing"],
"default" : "none",
"description" : "When performed on multiple indices, allows to ignore `missing` ones"
},
"operation_threading": {
"description" : "TODO: ?"
},
"source": {
"type" : "string",
"description" : "The URL-encoded query definition (instead of using the request body)"
}
}
},
"body": {
"description" : "The query definition"
}
}
}