Skip to content

Commit c116ebf

Browse files
Update rest-api-spec (#5011)
Co-authored-by: pquentin <[email protected]>
1 parent f2834ab commit c116ebf

File tree

3 files changed

+37
-20
lines changed

3 files changed

+37
-20
lines changed
Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,4 @@
11
{
2-
"endpointErrors": {
3-
"esql.async_query_get": {
4-
"request": [
5-
"Request: query parameter 'format' does not exist in the json spec"
6-
],
7-
"response": []
8-
},
9-
"msearch": {
10-
"request": [
11-
"Request: query parameter 'allow_no_indices' does not exist in the json spec",
12-
"Request: query parameter 'expand_wildcards' does not exist in the json spec",
13-
"Request: query parameter 'ignore_throttled' does not exist in the json spec",
14-
"Request: query parameter 'ignore_unavailable' does not exist in the json spec",
15-
"Request: query parameter 'include_named_queries_score' does not exist in the json spec",
16-
"Request: query parameter 'index' does not exist in the json spec",
17-
"Request: query parameter 'routing' does not exist in the json spec"
18-
],
19-
"response": []
20-
}
21-
},
2+
"endpointErrors": {},
223
"generalErrors": []
234
}

specification/_json_spec/esql.async_query_get.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
]
2525
},
2626
"params": {
27+
"format": {
28+
"type": "string",
29+
"description": "a short version of the Accept header, e.g. json, yaml"
30+
},
2731
"wait_for_completion_timeout": {
2832
"type": "time",
2933
"description": "Specify the time that the request should block waiting for the final response"

specification/_json_spec/msearch.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,38 @@
6060
"type": "boolean",
6161
"description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
6262
"default": "true"
63+
},
64+
"index": {
65+
"type": "list",
66+
"description": "A comma-separated list of index names to use as default"
67+
},
68+
"ignore_unavailable": {
69+
"type": "boolean",
70+
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
71+
},
72+
"ignore_throttled": {
73+
"type": "boolean",
74+
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled",
75+
"deprecated": true
76+
},
77+
"allow_no_indices": {
78+
"type": "boolean",
79+
"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)"
80+
},
81+
"expand_wildcards": {
82+
"type": "enum",
83+
"options": ["open", "closed", "hidden", "none", "all"],
84+
"default": "open",
85+
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
86+
},
87+
"routing": {
88+
"type": "list",
89+
"description": "A comma-separated list of specific routing values"
90+
},
91+
"include_named_queries_score": {
92+
"type": "boolean",
93+
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
94+
"default": false
6395
}
6496
},
6597
"body": {

0 commit comments

Comments
 (0)