Skip to content

Update rest-api-spec 9.1 #5651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 9.1
Choose a base branch
from
Open

Update rest-api-spec 9.1 #5651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specification/_json_spec/async_search.submit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/cat.aliases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"default": false
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/cat.indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
"default": false
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/cat.segments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"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."
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/clear_scroll.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@
"scroll_id": {
"type": "list",
"description": "A comma-separated list of scroll IDs to clear",
"deprecated": true
"deprecated": {
"version": "7.0.0",
"description": "A scroll id can be quite large and should be specified as part of the body"
}
}
},
"deprecated": {
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/cluster.exists_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"deprecated": {
"version": "9.0.0",
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/cluster.get_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"deprecated": {
"version": "9.0.0",
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/cluster.health.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
15 changes: 4 additions & 11 deletions specification/_json_spec/cluster.reroute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,10 @@
},
"metric": {
"type": "list",
"options": [
"_all",
"blocks",
"metadata",
"nodes",
"none",
"routing_table",
"master_node",
"version"
],
"default": "all",
"deprecated": {
"version": "8.6.0",
"description": "This parameter has no effect; its use will be forbidden in a future version."
},
"description": "Limit the information returned to the specified metrics. Defaults to all but metadata"
},
"master_timeout": {
Expand Down
8 changes: 7 additions & 1 deletion specification/_json_spec/cluster.state.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"options": [
"_all",
"blocks",
"customs",
"metadata",
"nodes",
"routing_table",
Expand All @@ -48,6 +49,7 @@
"options": [
"_all",
"blocks",
"customs",
"metadata",
"nodes",
"routing_table",
Expand All @@ -63,6 +65,10 @@
},
"params": {
"local": {
"deprecated": {
"version": "9.0.0",
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down Expand Up @@ -96,7 +102,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
6 changes: 5 additions & 1 deletion specification/_json_spec/count.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"ignore_throttled": {
"deprecated": {
"version": "7.16.0",
"description": "This parameter is deprecated because frozen indices have been deprecated."
},
"type": "boolean",
"default": true,
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled"
Expand All @@ -45,7 +49,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
6 changes: 5 additions & 1 deletion specification/_json_spec/delete_by_query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"description": "What to do when the delete by query hits version conflicts?"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down Expand Up @@ -106,6 +106,10 @@
"description": "Maximum number of documents to process (default: all documents)"
},
"sort": {
"deprecated": {
"version": "9.0.0",
"description": "This query parameter is not supported and will be removed in a future version"
},
"type": "list",
"description": "A comma-separated list of <field>:<direction> pairs"
},
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/eql.search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/field_caps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
7 changes: 4 additions & 3 deletions specification/_json_spec/indices.add_block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@
"description": "A comma separated list of indices to add a block to"
},
"block": {
"type": "string",
"description": "The block to add (one of read, write, read_only or metadata)"
"type": "enum",
"description": "The block to add (one of read, write, read_only or metadata)",
"options": ["metadata", "read", "read_only", "write"]
}
}
}
Expand Down Expand Up @@ -49,7 +50,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.clear_cache.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.close.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open,closed",
"description": "Whether wildcard expressions should get expanded to open, closed, or hidden indices"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.delete_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.delete_data_stream.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.delete_data_stream_options.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/indices.delete_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
},
"stability": "stable",
"visibility": "public",
"deprecated": {
"version": "7.8.0",
"description": "Legacy index templates are deprecated in favor of composable templates"
},
"headers": {
"accept": ["application/json"]
},
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.disk_usage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.exists.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.exists_alias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/indices.exists_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"deprecated": {
"version": "9.0.0",
"description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.field_usage_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.flush.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.forcemerge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@
"description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
},
"features": {
"type": "enum",
"type": "list",
"options": ["aliases", "mappings", "settings"],
"default": "aliases,mappings,settings",
"description": "Return only information on specified index features"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.get_alias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"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)"
},
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.get_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.get_data_stream.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"params": {
"expand_wildcards": {
"type": "enum",
"type": "list",
"options": ["open", "closed", "hidden", "none", "all"],
"default": "open",
"description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)"
Expand Down
Loading