Skip to content

Commit 5e81d61

Browse files
Update rest-api-spec (#4975)
Co-authored-by: pquentin <[email protected]>
1 parent 4804068 commit 5e81d61

File tree

3 files changed

+49
-14
lines changed

3 files changed

+49
-14
lines changed

output/schema/validation-errors.json

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,9 @@
66
],
77
"response": []
88
},
9-
"indices.recovery": {
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_unavailable' does not exist in the json spec"
14-
],
15-
"response": []
16-
},
179
"msearch": {
1810
"request": [
19-
"Request: query parameter 'allow_no_indices' does not exist in the json spec",
20-
"Request: query parameter 'expand_wildcards' does not exist in the json spec",
21-
"Request: query parameter 'ignore_throttled' does not exist in the json spec",
22-
"Request: query parameter 'ignore_unavailable' does not exist in the json spec",
23-
"Request: query parameter 'include_named_queries_score' does not exist in the json spec",
24-
"Request: query parameter 'routing' does not exist in the json spec"
11+
"Request: missing json spec query parameter 'index'"
2512
],
2613
"response": []
2714
}

specification/_json_spec/indices.recovery.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,22 @@
3737
"type": "boolean",
3838
"description": "Display only those recoveries that are currently on-going",
3939
"default": false
40+
},
41+
"ignore_unavailable": {
42+
"type": "boolean",
43+
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)",
44+
"default": false
45+
},
46+
"allow_no_indices": {
47+
"type": "boolean",
48+
"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)",
49+
"default": true
50+
},
51+
"expand_wildcards": {
52+
"type": "enum",
53+
"options": ["open", "closed", "hidden", "none", "all"],
54+
"default": "open",
55+
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
4056
}
4157
}
4258
}

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)