diff options
Diffstat (limited to 'rest-api-spec/api/delete_by_query.json')
-rw-r--r-- | rest-api-spec/api/delete_by_query.json | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/rest-api-spec/api/delete_by_query.json b/rest-api-spec/api/delete_by_query.json new file mode 100644 index 0000000..3480b7e --- /dev/null +++ b/rest-api-spec/api/delete_by_query.json @@ -0,0 +1,81 @@ +{ + "delete_by_query": { + "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html", + "methods": ["DELETE"], + "url": { + "path": "/{index}/_query", + "paths": ["/{index}/_query", "/{index}/{type}/_query"], + "parts": { + "index": { + "type" : "list", + "required": true, + "description" : "A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices" + }, + "type": { + "type" : "list", + "description" : "A comma-separated list of types to restrict the operation" + } + }, + "params": { + "analyzer": { + "type" : "string", + "description" : "The analyzer to use for the query string" + }, + "consistency": { + "type" : "enum", + "options" : ["one", "quorum", "all"], + "description" : "Specific write consistency setting for the operation" + }, + "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" + }, + "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"], + "default" : "open", + "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both." + }, + "replication": { + "type" : "enum", + "options" : ["sync","async"], + "default" : "sync", + "description" : "Specific replication type" + }, + "q": { + "type" : "string", + "description" : "Query in the Lucene query string syntax" + }, + "routing": { + "type" : "string", + "description" : "Specific routing value" + }, + "source": { + "type" : "string", + "description" : "The URL-encoded query definition (instead of using the request body)" + }, + "timeout": { + "type" : "time", + "description" : "Explicit operation timeout" + } + } + }, + "body": { + "description" : "A query to restrict the operation specified with the Query DSL" + } + } +} |