Skip to content

Commit ccea0e5

Browse files
pquentingithub-actions[bot]
authored andcommitted
Update rest-api-spec
1 parent 774ff3f commit ccea0e5

File tree

114 files changed

+433
-175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+433
-175
lines changed

specification/_json_spec/async_search.submit.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
"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)"
107107
},
108108
"expand_wildcards": {
109-
"type": "enum",
109+
"type": "list",
110110
"options": ["open", "closed", "hidden", "none", "all"],
111111
"default": "open",
112112
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

specification/_json_spec/cat.aliases.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"default": false
5353
},
5454
"expand_wildcards": {
55-
"type": "enum",
55+
"type": "list",
5656
"options": ["open", "closed", "hidden", "none", "all"],
5757
"default": "all",
5858
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

specification/_json_spec/cat.indices.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
"default": false
8383
},
8484
"expand_wildcards": {
85-
"type": "enum",
85+
"type": "list",
8686
"options": ["open", "closed", "hidden", "none", "all"],
8787
"default": "all",
8888
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

specification/_json_spec/cat.segments.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
"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). Only allowed when providing an index expression."
8989
},
9090
"expand_wildcards": {
91-
"type": "enum",
91+
"type": "list",
9292
"options": ["open", "closed", "hidden", "none", "all"],
9393
"default": "open",
9494
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

specification/_json_spec/clear_scroll.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323
"scroll_id": {
2424
"type": "list",
2525
"description": "A comma-separated list of scroll IDs to clear",
26-
"deprecated": true
26+
"deprecated": {
27+
"version": "7.0.0",
28+
"description": "A scroll id can be quite large and should be specified as part of the body"
29+
}
2730
}
2831
},
2932
"deprecated": {

specification/_json_spec/cluster.exists_component_template.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@
3030
"description": "Timeout for waiting for new cluster state in case it is blocked"
3131
},
3232
"local": {
33-
"deprecated": true,
33+
"deprecated": {
34+
"version": "9.0.0",
35+
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
36+
},
3437
"type": "boolean",
3538
"default": false,
3639
"description": "Return local information, do not retrieve the state from master node (default: false)"

specification/_json_spec/cluster.get_component_template.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@
3434
"description": "Timeout for waiting for new cluster state in case it is blocked"
3535
},
3636
"local": {
37-
"deprecated": true,
37+
"deprecated": {
38+
"version": "9.0.0",
39+
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
40+
},
3841
"type": "boolean",
3942
"default": false,
4043
"description": "Return local information, do not retrieve the state from master node (default: false)"

specification/_json_spec/cluster.health.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
},
3030
"params": {
3131
"expand_wildcards": {
32-
"type": "enum",
32+
"type": "list",
3333
"options": ["open", "closed", "hidden", "none", "all"],
3434
"default": "all",
3535
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

specification/_json_spec/cluster.reroute.json

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,10 @@
3636
},
3737
"metric": {
3838
"type": "list",
39-
"options": [
40-
"_all",
41-
"blocks",
42-
"metadata",
43-
"nodes",
44-
"none",
45-
"routing_table",
46-
"master_node",
47-
"version"
48-
],
49-
"default": "all",
39+
"deprecated": {
40+
"version": "8.6.0",
41+
"description": "This parameter has no effect; its use will be forbidden in a future version."
42+
},
5043
"description": "Limit the information returned to the specified metrics. Defaults to all but metadata"
5144
},
5245
"master_timeout": {

specification/_json_spec/cluster.state.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
"options": [
2525
"_all",
2626
"blocks",
27+
"customs",
2728
"metadata",
2829
"nodes",
2930
"routing_table",
@@ -48,6 +49,7 @@
4849
"options": [
4950
"_all",
5051
"blocks",
52+
"customs",
5153
"metadata",
5254
"nodes",
5355
"routing_table",
@@ -63,6 +65,10 @@
6365
},
6466
"params": {
6567
"local": {
68+
"deprecated": {
69+
"version": "9.0.0",
70+
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
71+
},
6672
"type": "boolean",
6773
"default": false,
6874
"description": "Return local information, do not retrieve the state from master node (default: false)"
@@ -96,7 +102,7 @@
96102
"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)"
97103
},
98104
"expand_wildcards": {
99-
"type": "enum",
105+
"type": "list",
100106
"options": ["open", "closed", "hidden", "none", "all"],
101107
"default": "open",
102108
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

0 commit comments

Comments
 (0)