Skip to content

Update rest-api-spec main #5679

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: main
Choose a base branch
from
Open

Update rest-api-spec main #5679

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
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
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
7 changes: 6 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,7 +65,10 @@
},
"params": {
"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
4 changes: 4 additions & 0 deletions 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 Down
4 changes: 4 additions & 0 deletions specification/_json_spec/delete_by_query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
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
4 changes: 3 additions & 1 deletion specification/_json_spec/indices.delete_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.delete_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Delete sampling configuration for an index or data stream"
},
"stability": "experimental",
Expand All @@ -28,10 +28,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for the request"
}
}
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
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
3 changes: 2 additions & 1 deletion specification/_json_spec/indices.get_all_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.get_all_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get sampling configurations for all indices and data streams"
},
"stability": "experimental",
Expand All @@ -21,6 +21,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/indices.get_index_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,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/indices.get_mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@
},
"local": {
"type": "boolean",
"deprecated": true,
"deprecated": {
"version": "7.8.0",
"description": "This parameter is a no-op and field mappings are always retrieved locally."
},
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
Expand Down
5 changes: 3 additions & 2 deletions specification/_json_spec/indices.get_sample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"indices.get_sample": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get random sample of ingested data"
},
"stability": "experimental",
"visibility": "public",
"visibility": "feature_flag",
"feature_flag": "random_sampling",
"headers": {
"accept": ["application/json"]
},
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/indices.get_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.get_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get sampling configuration for an index or data stream"
},
"stability": "experimental",
Expand All @@ -27,6 +27,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
5 changes: 3 additions & 2 deletions specification/_json_spec/indices.get_sample_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"indices.get_sample_stats": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get stats about a random sample of ingested data"
},
"stability": "experimental",
"visibility": "public",
"visibility": "feature_flag",
"feature_flag": "random_sampling",
"headers": {
"accept": ["application/json"]
},
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/indices.get_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,10 @@
"description": "Return settings in flat format (default: false)"
},
"local": {
"deprecated": true,
"deprecated": {
"version": "9.1.0",
"description": "This parameter is a no-op and settings are always retrieved locally."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
9 changes: 8 additions & 1 deletion specification/_json_spec/indices.get_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 Expand Up @@ -39,7 +43,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 is a no-op and templates are always retrieved locally."
},
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
4 changes: 3 additions & 1 deletion specification/_json_spec/indices.put_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.put_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Configure sampling for an index or data stream"
},
"stability": "experimental",
Expand All @@ -28,10 +28,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for the request"
}
},
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/indices.put_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"],
"content_type": ["application/json"]
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/indices.resolve_cluster.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
"description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression."
},
"ignore_throttled": {
"deprecated": {
"version": "7.16.0",
"description": "This parameter is deprecated because frozen indices have been deprecated."
},
"type": "boolean",
"default": false,
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression."
Expand Down
16 changes: 14 additions & 2 deletions specification/_json_spec/indices.stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,20 @@
"flush",
"get",
"indexing",
"mappings",
"merge",
"recovery",
"request_cache",
"refresh",
"search",
"segments",
"shard_stats",
"store",
"translog",
"warmer",
"bulk"
"bulk",
"dense_vector",
"sparse_vector"
],
"description": "Limit the information returned the specific metrics."
}
Expand Down Expand Up @@ -72,14 +78,20 @@
"flush",
"get",
"indexing",
"mappings",
"merge",
"recovery",
"request_cache",
"refresh",
"search",
"segments",
"shard_stats",
"store",
"translog",
"warmer",
"bulk"
"bulk",
"dense_vector",
"sparse_vector"
],
"description": "Limit the information returned the specific metrics."
}
Expand Down
5 changes: 4 additions & 1 deletion specification/_json_spec/license.get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@
},
"accept_enterprise": {
"type": "boolean",
"deprecated": true,
"deprecated": {
"version": "7.6.0",
"description": "This parameter no longer has any effect"
},
"default": true,
"description": "Supported for backwards compatibility with 7.x. If this param is used it must be set to true"
}
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/ml.flush_job.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": "9.1.0",
"description": "Forcing any buffered data to be processed is deprecated, in a future major version a datafeed will be required."
},
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
Expand Down
4 changes: 4 additions & 0 deletions specification/_json_spec/ml.post_data.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.11.0",
"description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required."
},
"headers": {
"accept": ["application/json"],
"content_type": ["application/x-ndjson", "application/json"]
Expand Down
Loading