From 8cdd42c0f4df0ac3bb2d68d49de4acc5af880cfa Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 15 Nov 2025 04:07:12 +0000 Subject: [PATCH] Update rest-api-spec --- specification/_json_spec/clear_scroll.json | 5 +- .../cluster.exists_component_template.json | 5 +- .../cluster.get_component_template.json | 5 +- specification/_json_spec/cluster.reroute.json | 15 ++--- specification/_json_spec/cluster.state.json | 7 +- specification/_json_spec/count.json | 4 ++ specification/_json_spec/delete_by_query.json | 4 ++ .../indices.delete_sample_configuration.json | 4 +- .../_json_spec/indices.delete_template.json | 4 ++ .../_json_spec/indices.exists_template.json | 5 +- .../indices.get_all_sample_configuration.json | 3 +- .../indices.get_index_template.json | 5 +- .../_json_spec/indices.get_mapping.json | 5 +- .../_json_spec/indices.get_sample.json | 5 +- .../indices.get_sample_configuration.json | 3 +- .../_json_spec/indices.get_sample_stats.json | 5 +- .../_json_spec/indices.get_settings.json | 5 +- .../_json_spec/indices.get_template.json | 9 ++- .../indices.put_sample_configuration.json | 4 +- .../_json_spec/indices.put_template.json | 4 ++ .../_json_spec/indices.resolve_cluster.json | 4 ++ specification/_json_spec/indices.stats.json | 16 ++++- specification/_json_spec/license.get.json | 5 +- specification/_json_spec/ml.flush_job.json | 4 ++ specification/_json_spec/ml.post_data.json | 4 ++ specification/_json_spec/ml.put_datafeed.json | 4 ++ specification/_json_spec/ml.put_job.json | 4 ++ .../_json_spec/ml.update_datafeed.json | 4 ++ specification/_json_spec/monitoring.bulk.json | 5 +- specification/_json_spec/msearch.json | 5 +- specification/_json_spec/nodes.info.json | 10 ++- specification/_json_spec/nodes.stats.json | 64 +++++++++++++++---- specification/_json_spec/nodes.usage.json | 4 +- .../_json_spec/rollup.delete_job.json | 4 ++ specification/_json_spec/rollup.get_jobs.json | 4 ++ .../_json_spec/rollup.get_rollup_caps.json | 4 ++ .../rollup.get_rollup_index_caps.json | 4 ++ specification/_json_spec/rollup.put_job.json | 4 ++ .../_json_spec/rollup.rollup_search.json | 4 ++ .../_json_spec/rollup.start_job.json | 4 ++ specification/_json_spec/rollup.stop_job.json | 4 ++ specification/_json_spec/scroll.json | 9 ++- specification/_json_spec/search.json | 4 ++ specification/_json_spec/search_template.json | 4 ++ 44 files changed, 235 insertions(+), 53 deletions(-) diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index 72cf6c59df..a07edf9920 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -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": { diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index 0ce28f607f..cbd6e21f7f 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -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)" diff --git a/specification/_json_spec/cluster.get_component_template.json b/specification/_json_spec/cluster.get_component_template.json index 8c18bfc80f..3d17770164 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -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)" diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 41f86859c0..fbb0c1fb96 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -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": { diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index 16990a542a..8264b73f4c 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -24,6 +24,7 @@ "options": [ "_all", "blocks", + "customs", "metadata", "nodes", "routing_table", @@ -48,6 +49,7 @@ "options": [ "_all", "blocks", + "customs", "metadata", "nodes", "routing_table", @@ -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)" diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index 52cce60605..945c99b321 100644 --- a/specification/_json_spec/count.json +++ b/specification/_json_spec/count.json @@ -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" diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index 425d6f23ff..ee10aff380 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -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 : pairs" }, diff --git a/specification/_json_spec/indices.delete_sample_configuration.json b/specification/_json_spec/indices.delete_sample_configuration.json index 6302e794cd..9dae8855cf 100644 --- a/specification/_json_spec/indices.delete_sample_configuration.json +++ b/specification/_json_spec/indices.delete_sample_configuration.json @@ -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", @@ -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" } } diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index d047052d89..d6af33843a 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -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"] }, diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json index f4a859c8ab..a10f6fbd3c 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -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)" diff --git a/specification/_json_spec/indices.get_all_sample_configuration.json b/specification/_json_spec/indices.get_all_sample_configuration.json index 655eab365b..42e12d9e2c 100644 --- a/specification/_json_spec/indices.get_all_sample_configuration.json +++ b/specification/_json_spec/indices.get_all_sample_configuration.json @@ -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", @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json index 1c7b97c2ed..1943121a72 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -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)" diff --git a/specification/_json_spec/indices.get_mapping.json b/specification/_json_spec/indices.get_mapping.json index 633150c864..befbc7375b 100644 --- a/specification/_json_spec/indices.get_mapping.json +++ b/specification/_json_spec/indices.get_mapping.json @@ -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)" } diff --git a/specification/_json_spec/indices.get_sample.json b/specification/_json_spec/indices.get_sample.json index 51e783e1ea..1b3f71edd5 100644 --- a/specification/_json_spec/indices.get_sample.json +++ b/specification/_json_spec/indices.get_sample.json @@ -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"] }, diff --git a/specification/_json_spec/indices.get_sample_configuration.json b/specification/_json_spec/indices.get_sample_configuration.json index 97dcac0ad6..a0419d4433 100644 --- a/specification/_json_spec/indices.get_sample_configuration.json +++ b/specification/_json_spec/indices.get_sample_configuration.json @@ -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", @@ -27,6 +27,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/indices.get_sample_stats.json b/specification/_json_spec/indices.get_sample_stats.json index 04ace3b2ae..ad11bf38c9 100644 --- a/specification/_json_spec/indices.get_sample_stats.json +++ b/specification/_json_spec/indices.get_sample_stats.json @@ -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"] }, diff --git a/specification/_json_spec/indices.get_settings.json b/specification/_json_spec/indices.get_settings.json index 608faf03ae..02c0ad907a 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -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)" diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index d30a3be0ab..03b4612ce5 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -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"] }, @@ -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)" diff --git a/specification/_json_spec/indices.put_sample_configuration.json b/specification/_json_spec/indices.put_sample_configuration.json index 80576f29c4..fd5675598e 100644 --- a/specification/_json_spec/indices.put_sample_configuration.json +++ b/specification/_json_spec/indices.put_sample_configuration.json @@ -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", @@ -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" } }, diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index 9d7f96094d..739271c5c3 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -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"] diff --git a/specification/_json_spec/indices.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 3918547bca..5b8a18c272 100644 --- a/specification/_json_spec/indices.resolve_cluster.json +++ b/specification/_json_spec/indices.resolve_cluster.json @@ -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." diff --git a/specification/_json_spec/indices.stats.json b/specification/_json_spec/indices.stats.json index ea158a5174..087dde90fa 100644 --- a/specification/_json_spec/indices.stats.json +++ b/specification/_json_spec/indices.stats.json @@ -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." } @@ -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." } diff --git a/specification/_json_spec/license.get.json b/specification/_json_spec/license.get.json index b34d5548ed..b38748ad5d 100644 --- a/specification/_json_spec/license.get.json +++ b/specification/_json_spec/license.get.json @@ -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" } diff --git a/specification/_json_spec/ml.flush_job.json b/specification/_json_spec/ml.flush_job.json index 3ae8367eae..fd202e27fe 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -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"] diff --git a/specification/_json_spec/ml.post_data.json b/specification/_json_spec/ml.post_data.json index 7a59fa3ea9..fa2a6287ad 100644 --- a/specification/_json_spec/ml.post_data.json +++ b/specification/_json_spec/ml.post_data.json @@ -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"] diff --git a/specification/_json_spec/ml.put_datafeed.json b/specification/_json_spec/ml.put_datafeed.json index 86a8c0a5e6..cc7df467e6 100644 --- a/specification/_json_spec/ml.put_datafeed.json +++ b/specification/_json_spec/ml.put_datafeed.json @@ -40,6 +40,10 @@ "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Ignore indices that are marked as throttled (default: true)" diff --git a/specification/_json_spec/ml.put_job.json b/specification/_json_spec/ml.put_job.json index fde6c31fb4..0774e2fbac 100644 --- a/specification/_json_spec/ml.put_job.json +++ b/specification/_json_spec/ml.put_job.json @@ -36,6 +36,10 @@ "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided." }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided." diff --git a/specification/_json_spec/ml.update_datafeed.json b/specification/_json_spec/ml.update_datafeed.json index 17dbeeaf2f..6f9f56dc1a 100644 --- a/specification/_json_spec/ml.update_datafeed.json +++ b/specification/_json_spec/ml.update_datafeed.json @@ -40,6 +40,10 @@ "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Ignore indices that are marked as throttled (default: true)" diff --git a/specification/_json_spec/monitoring.bulk.json b/specification/_json_spec/monitoring.bulk.json index 9eb9fbc49f..9495cf555c 100644 --- a/specification/_json_spec/monitoring.bulk.json +++ b/specification/_json_spec/monitoring.bulk.json @@ -23,7 +23,10 @@ "type": { "type": "string", "description": "Default document type for items which don't provide one", - "deprecated": true + "deprecated": { + "version": "7.0.0", + "description": "Specifying types in urls has been deprecated" + } } }, "deprecated": { diff --git a/specification/_json_spec/msearch.json b/specification/_json_spec/msearch.json index 2426071e84..fd49667fb4 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -72,7 +72,10 @@ }, "ignore_throttled": { "type": "boolean", - "deprecated": true, + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "default": false, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, diff --git a/specification/_json_spec/nodes.info.json b/specification/_json_spec/nodes.info.json index 5ddcbe79a5..05cabbe5a8 100644 --- a/specification/_json_spec/nodes.info.json +++ b/specification/_json_spec/nodes.info.json @@ -32,9 +32,12 @@ "metric": { "type": "list", "options": [ + "_all", + "_none", "settings", "os", "process", + "remote_cluster_server", "jvm", "thread_pool", "transport", @@ -59,9 +62,12 @@ "metric": { "type": "list", "options": [ + "_all", + "_none", "settings", "os", "process", + "remote_cluster_server", "jvm", "thread_pool", "transport", @@ -69,9 +75,7 @@ "plugins", "ingest", "indices", - "aggregations", - "_all", - "_none" + "aggregations" ], "description": "A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics." } diff --git a/specification/_json_spec/nodes.stats.json b/specification/_json_spec/nodes.stats.json index 25367ca8c9..f3dcabeed5 100644 --- a/specification/_json_spec/nodes.stats.json +++ b/specification/_json_spec/nodes.stats.json @@ -33,18 +33,24 @@ "type": "list", "options": [ "_all", + "_none", + "adaptive_selection", + "allocations", "breaker", + "discovery", "fs", "http", + "indexing_pressure", "indices", "ingest", "jvm", "os", "process", + "repositories", + "script", + "script_cache", "thread_pool", - "transport", - "discovery", - "indexing_pressure" + "transport" ], "description": "Limit the information returned to the specified metrics" } @@ -58,18 +64,24 @@ "type": "list", "options": [ "_all", + "_none", + "adaptive_selection", + "allocations", "breaker", + "discovery", "fs", "http", + "indexing_pressure", "indices", "ingest", "jvm", "os", "process", + "repositories", + "script", + "script_cache", "thread_pool", - "transport", - "discovery", - "indexing_pressure" + "transport" ], "description": "Limit the information returned to the specified metrics" }, @@ -87,17 +99,24 @@ "type": "list", "options": [ "_all", + "_none", + "adaptive_selection", + "allocations", "breaker", + "discovery", "fs", "http", + "indexing_pressure", "indices", + "ingest", "jvm", "os", "process", + "repositories", + "script", + "script_cache", "thread_pool", - "transport", - "discovery", - "indexing_pressure" + "transport" ], "description": "Limit the information returned to the specified metrics" }, @@ -112,15 +131,20 @@ "flush", "get", "indexing", + "mappings", "merge", "request_cache", + "recovery", "refresh", "search", "segments", "store", "warmer", "bulk", - "shard_stats" + "shard_stats", + "translog", + "dense_vector", + "sparse_vector" ], "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified." } @@ -134,17 +158,24 @@ "type": "list", "options": [ "_all", + "_none", + "adaptive_selection", + "allocations", "breaker", + "discovery", "fs", "http", + "indexing_pressure", "indices", + "ingest", "jvm", "os", "process", + "repositories", + "script", + "script_cache", "thread_pool", - "transport", - "discovery", - "indexing_pressure" + "transport" ], "description": "Limit the information returned to the specified metrics" }, @@ -159,15 +190,20 @@ "flush", "get", "indexing", + "mappings", "merge", "request_cache", + "recovery", "refresh", "search", "segments", "store", "warmer", "bulk", - "shard_stats" + "shard_stats", + "translog", + "dense_vector", + "sparse_vector" ], "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified." }, diff --git a/specification/_json_spec/nodes.usage.json b/specification/_json_spec/nodes.usage.json index f749aab32a..a47ecbba51 100644 --- a/specification/_json_spec/nodes.usage.json +++ b/specification/_json_spec/nodes.usage.json @@ -31,7 +31,7 @@ "parts": { "metric": { "type": "list", - "options": ["_all", "rest_actions"], + "options": ["_all", "aggregations", "rest_actions"], "description": "Limit the information returned to the specified metrics" } } @@ -42,7 +42,7 @@ "parts": { "metric": { "type": "list", - "options": ["_all", "rest_actions"], + "options": ["_all", "aggregations", "rest_actions"], "description": "Limit the information returned to the specified metrics" }, "node_id": { diff --git a/specification/_json_spec/rollup.delete_job.json b/specification/_json_spec/rollup.delete_job.json index 24d6f83363..ba791ecc3d 100644 --- a/specification/_json_spec/rollup.delete_job.json +++ b/specification/_json_spec/rollup.delete_job.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/rollup.get_jobs.json b/specification/_json_spec/rollup.get_jobs.json index 3629fd7c4b..3991875832 100644 --- a/specification/_json_spec/rollup.get_jobs.json +++ b/specification/_json_spec/rollup.get_jobs.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/rollup.get_rollup_caps.json b/specification/_json_spec/rollup.get_rollup_caps.json index 274e473113..fcd88b43de 100644 --- a/specification/_json_spec/rollup.get_rollup_caps.json +++ b/specification/_json_spec/rollup.get_rollup_caps.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/rollup.get_rollup_index_caps.json b/specification/_json_spec/rollup.get_rollup_index_caps.json index 1439b2f9db..b6abb6cd9b 100644 --- a/specification/_json_spec/rollup.get_rollup_index_caps.json +++ b/specification/_json_spec/rollup.get_rollup_index_caps.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/rollup.put_job.json b/specification/_json_spec/rollup.put_job.json index 535b657d54..06b6604523 100644 --- a/specification/_json_spec/rollup.put_job.json +++ b/specification/_json_spec/rollup.put_job.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/rollup.rollup_search.json b/specification/_json_spec/rollup.rollup_search.json index 4f63574097..d732e9c2c8 100644 --- a/specification/_json_spec/rollup.rollup_search.json +++ b/specification/_json_spec/rollup.rollup_search.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/rollup.start_job.json b/specification/_json_spec/rollup.start_job.json index 168d4dbb03..f998517fb7 100644 --- a/specification/_json_spec/rollup.start_job.json +++ b/specification/_json_spec/rollup.start_job.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/rollup.stop_job.json b/specification/_json_spec/rollup.stop_job.json index 6ac3e019b3..5024391bc6 100644 --- a/specification/_json_spec/rollup.stop_job.json +++ b/specification/_json_spec/rollup.stop_job.json @@ -6,6 +6,10 @@ }, "stability": "experimental", "visibility": "public", + "deprecated": { + "version": "8.11.0", + "description": "Rollup APIs are deprecated, use downsampling with time series data stream instead" + }, "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/scroll.json b/specification/_json_spec/scroll.json index 177901e371..3f54a6f6f0 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -23,7 +23,10 @@ "scroll_id": { "type": "string", "description": "The scroll ID", - "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": { @@ -40,6 +43,10 @@ "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "scroll_id": { + "deprecated": { + "version": "7.0.0", + "description": "A scroll id can be quite large and should be specified as part of the body" + }, "type": "string", "description": "The scroll ID for scrolled search" }, diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index a2d9b48fe5..a73d6ec616 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -83,6 +83,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" diff --git a/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index 188b4724b6..9aeb0386c9 100644 --- a/specification/_json_spec/search_template.json +++ b/specification/_json_spec/search_template.json @@ -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"