forked from elastic/elasticsearch-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathexplain.json
87 lines (87 loc) · 2.68 KB
/
explain.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
"explain": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html",
"description": "Returns information about why a specific matches (or doesn't match) a query."
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/{index}/_explain/{id}",
"methods": ["GET", "POST"],
"parts": {
"id": {
"type": "string",
"description": "The document ID"
},
"index": {
"type": "string",
"description": "The name of the index"
}
}
}
]
},
"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)"
},
"stored_fields": {
"type": "list",
"description": "A comma-separated list of stored 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"
},
"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": "list",
"description": "True or false to return the _source field or not, or a list of fields to return"
},
"_source_excludes": {
"type": "list",
"description": "A list of fields to exclude from the returned _source field"
},
"_source_includes": {
"type": "list",
"description": "A list of fields to extract and return from the _source field"
}
},
"body": {
"description": "The query definition using the Query DSL"
}
}
}