diff options
Diffstat (limited to 'rest-api-spec/api/explain.json')
-rw-r--r-- | rest-api-spec/api/explain.json | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/rest-api-spec/api/explain.json b/rest-api-spec/api/explain.json new file mode 100644 index 0000000..bee897b --- /dev/null +++ b/rest-api-spec/api/explain.json @@ -0,0 +1,94 @@ +{ + "explain": { + "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html", + "methods": ["GET", "POST"], + "url": { + "path": "/{index}/{type}/{id}/_explain", + "paths": ["/{index}/{type}/{id}/_explain"], + "parts": { + "id": { + "type" : "string", + "required" : true, + "description" : "The document ID" + }, + "index": { + "type" : "string", + "required" : true, + "description" : "The name of the index" + }, + "type": { + "type" : "string", + "required" : true, + "description" : "The type of the document" + } + }, + "params": { + "analyze_wildcard": { + "type" : "boolean", + "description" : "Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)" + }, + "analyzer": { + "type" : "string", + "description" : "The analyzer for the query string query" + }, + "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 default field for query string query (default: _all)" + }, + "fields": { + "type": "list", + "description" : "A comma-separated list of fields to return in the response" + }, + "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" + }, + "parent": { + "type" : "string", + "description" : "The ID of the parent document" + }, + "preference": { + "type" : "string", + "description" : "Specify the node or shard the operation should be performed on (default: random)" + }, + "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)" + }, + "_source": { + "type" : "list", + "description" : "True or false to return the _source field or not, or a list of fields to return" + }, + "_source_exclude": { + "type" : "list", + "description" : "A list of fields to exclude from the returned _source field" + }, + "_source_include": { + "type" : "list", + "description" : "A list of fields to extract and return from the _source field" + } + } + }, + "body": { + "description" : "The query definition using the Query DSL" + } + } +} |