From ccea0e5459602d051a64abadbcf3cdcb35980721 Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 15 Nov 2025 04:07:05 +0000 Subject: [PATCH] Update rest-api-spec --- .../_json_spec/async_search.submit.json | 2 +- specification/_json_spec/cat.aliases.json | 2 +- specification/_json_spec/cat.indices.json | 2 +- specification/_json_spec/cat.segments.json | 2 +- specification/_json_spec/clear_scroll.json | 5 +- .../cluster.exists_component_template.json | 5 +- .../cluster.get_component_template.json | 5 +- specification/_json_spec/cluster.health.json | 2 +- specification/_json_spec/cluster.reroute.json | 15 ++--- specification/_json_spec/cluster.state.json | 8 ++- specification/_json_spec/count.json | 6 +- specification/_json_spec/delete_by_query.json | 6 +- specification/_json_spec/eql.search.json | 2 +- specification/_json_spec/field_caps.json | 2 +- .../_json_spec/indices.add_block.json | 7 +- .../_json_spec/indices.clear_cache.json | 2 +- specification/_json_spec/indices.close.json | 2 +- specification/_json_spec/indices.delete.json | 2 +- .../indices.delete_data_lifecycle.json | 2 +- .../indices.delete_data_stream.json | 2 +- .../indices.delete_data_stream_options.json | 2 +- .../_json_spec/indices.delete_template.json | 4 ++ .../_json_spec/indices.disk_usage.json | 2 +- specification/_json_spec/indices.exists.json | 2 +- .../_json_spec/indices.exists_alias.json | 2 +- .../_json_spec/indices.exists_template.json | 5 +- .../_json_spec/indices.field_usage_stats.json | 2 +- specification/_json_spec/indices.flush.json | 2 +- .../_json_spec/indices.forcemerge.json | 2 +- specification/_json_spec/indices.get.json | 4 +- .../_json_spec/indices.get_alias.json | 2 +- .../indices.get_data_lifecycle.json | 2 +- .../_json_spec/indices.get_data_stream.json | 2 +- .../indices.get_data_stream_options.json | 2 +- .../_json_spec/indices.get_field_mapping.json | 2 +- .../indices.get_index_template.json | 5 +- .../_json_spec/indices.get_mapping.json | 7 +- .../_json_spec/indices.get_settings.json | 7 +- .../_json_spec/indices.get_template.json | 9 ++- specification/_json_spec/indices.open.json | 2 +- .../indices.put_data_lifecycle.json | 2 +- .../indices.put_data_stream_options.json | 2 +- .../_json_spec/indices.put_mapping.json | 2 +- .../_json_spec/indices.put_settings.json | 2 +- .../_json_spec/indices.put_template.json | 4 ++ .../_json_spec/indices.recovery.json | 2 +- specification/_json_spec/indices.refresh.json | 2 +- .../indices.reload_search_analyzers.json | 2 +- .../_json_spec/indices.remove_block.json | 7 +- .../_json_spec/indices.resolve_cluster.json | 6 +- .../_json_spec/indices.resolve_index.json | 2 +- .../_json_spec/indices.segments.json | 2 +- .../_json_spec/indices.shard_stores.json | 2 +- specification/_json_spec/indices.stats.json | 18 +++++- .../_json_spec/indices.validate_query.json | 2 +- .../_json_spec/inference.delete.json | 11 +++- specification/_json_spec/inference.get.json | 11 +++- .../_json_spec/inference.inference.json | 11 +++- specification/_json_spec/inference.put.json | 11 +++- .../inference.put_alibabacloud.json | 10 ++- .../inference.put_amazonbedrock.json | 5 +- .../inference.put_amazonsagemaker.json | 11 +++- .../_json_spec/inference.put_anthropic.json | 5 +- .../inference.put_azureaistudio.json | 5 +- .../_json_spec/inference.put_azureopenai.json | 5 +- .../_json_spec/inference.put_cohere.json | 5 +- .../_json_spec/inference.put_custom.json | 10 ++- .../_json_spec/inference.put_deepseek.json | 5 +- .../inference.put_elasticsearch.json | 5 +- .../_json_spec/inference.put_elser.json | 5 +- .../inference.put_googleaistudio.json | 5 +- .../inference.put_googlevertexai.json | 10 ++- .../inference.put_hugging_face.json | 10 ++- .../_json_spec/inference.put_jinaai.json | 5 +- .../_json_spec/inference.put_mistral.json | 5 +- .../_json_spec/inference.put_openai.json | 5 +- .../_json_spec/inference.put_voyageai.json | 5 +- .../_json_spec/inference.put_watsonx.json | 5 +- .../_json_spec/inference.update.json | 11 +++- specification/_json_spec/license.get.json | 5 +- specification/_json_spec/ml.flush_job.json | 12 ++-- specification/_json_spec/ml.get_buckets.json | 4 +- .../_json_spec/ml.get_calendar_events.json | 2 +- .../_json_spec/ml.get_influencers.json | 4 +- .../_json_spec/ml.get_overall_buckets.json | 4 +- specification/_json_spec/ml.get_records.json | 4 +- specification/_json_spec/ml.post_data.json | 8 ++- .../_json_spec/ml.preview_datafeed.json | 4 +- specification/_json_spec/ml.put_datafeed.json | 6 +- specification/_json_spec/ml.put_job.json | 6 +- .../_json_spec/ml.start_datafeed.json | 4 +- .../_json_spec/ml.update_datafeed.json | 6 +- specification/_json_spec/monitoring.bulk.json | 5 +- specification/_json_spec/msearch.json | 7 +- specification/_json_spec/nodes.info.json | 10 ++- specification/_json_spec/nodes.stats.json | 64 +++++++++++++++---- specification/_json_spec/nodes.usage.json | 4 +- .../_json_spec/open_point_in_time.json | 2 +- specification/_json_spec/rank_eval.json | 2 +- .../_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 | 6 +- ...ation.post_behavioral_analytics_event.json | 5 +- specification/_json_spec/search_shards.json | 2 +- specification/_json_spec/search_template.json | 6 +- .../searchable_snapshots.clear_cache.json | 2 +- specification/_json_spec/update_by_query.json | 2 +- 114 files changed, 433 insertions(+), 175 deletions(-) diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index 5d335c611b..9ee07314b9 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -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." diff --git a/specification/_json_spec/cat.aliases.json b/specification/_json_spec/cat.aliases.json index 9fc78fd6fd..b31fc567fa 100644 --- a/specification/_json_spec/cat.aliases.json +++ b/specification/_json_spec/cat.aliases.json @@ -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." diff --git a/specification/_json_spec/cat.indices.json b/specification/_json_spec/cat.indices.json index 9cb526b086..69876da174 100644 --- a/specification/_json_spec/cat.indices.json +++ b/specification/_json_spec/cat.indices.json @@ -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." diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index 9e37e9b195..b8e0f0d41a 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -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." diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index 31881b7c3a..ae806e5e66 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.health.json b/specification/_json_spec/cluster.health.json index 55c9036715..b03617e463 100644 --- a/specification/_json_spec/cluster.health.json +++ b/specification/_json_spec/cluster.health.json @@ -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." diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 18bd6459b9..028f9c9191 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 d41a1cb200..f69272c608 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,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)" @@ -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." diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index e6911e8b9e..3c8d1a9b26 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" @@ -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." diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index 8f31179187..bacc27b2f6 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -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." @@ -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/eql.search.json b/specification/_json_spec/eql.search.json index edd1f3185d..ec578c7ea1 100644 --- a/specification/_json_spec/eql.search.json +++ b/specification/_json_spec/eql.search.json @@ -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." diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index ea06e8dd92..650a66fcab 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -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." diff --git a/specification/_json_spec/indices.add_block.json b/specification/_json_spec/indices.add_block.json index 36cedbc06d..bf0db92db2 100644 --- a/specification/_json_spec/indices.add_block.json +++ b/specification/_json_spec/indices.add_block.json @@ -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"] } } } @@ -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." diff --git a/specification/_json_spec/indices.clear_cache.json b/specification/_json_spec/indices.clear_cache.json index 62ea4b5255..cb5fd0e633 100644 --- a/specification/_json_spec/indices.clear_cache.json +++ b/specification/_json_spec/indices.clear_cache.json @@ -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." diff --git a/specification/_json_spec/indices.close.json b/specification/_json_spec/indices.close.json index ed9ec0f28b..0781d384b9 100644 --- a/specification/_json_spec/indices.close.json +++ b/specification/_json_spec/indices.close.json @@ -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." diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index f63ca2ad35..77a514f320 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -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" diff --git a/specification/_json_spec/indices.delete_data_lifecycle.json b/specification/_json_spec/indices.delete_data_lifecycle.json index 3cc331f44a..83242af1f5 100644 --- a/specification/_json_spec/indices.delete_data_lifecycle.json +++ b/specification/_json_spec/indices.delete_data_lifecycle.json @@ -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)" diff --git a/specification/_json_spec/indices.delete_data_stream.json b/specification/_json_spec/indices.delete_data_stream.json index 84e95876ec..f9b9661892 100644 --- a/specification/_json_spec/indices.delete_data_stream.json +++ b/specification/_json_spec/indices.delete_data_stream.json @@ -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)" diff --git a/specification/_json_spec/indices.delete_data_stream_options.json b/specification/_json_spec/indices.delete_data_stream_options.json index 3ec19540d1..604e67f2a7 100644 --- a/specification/_json_spec/indices.delete_data_stream_options.json +++ b/specification/_json_spec/indices.delete_data_stream_options.json @@ -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)" 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.disk_usage.json b/specification/_json_spec/indices.disk_usage.json index 18319b4801..b4a7cf3767 100644 --- a/specification/_json_spec/indices.disk_usage.json +++ b/specification/_json_spec/indices.disk_usage.json @@ -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." diff --git a/specification/_json_spec/indices.exists.json b/specification/_json_spec/indices.exists.json index 0cbadffe70..ac9f78be5d 100644 --- a/specification/_json_spec/indices.exists.json +++ b/specification/_json_spec/indices.exists.json @@ -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)" diff --git a/specification/_json_spec/indices.exists_alias.json b/specification/_json_spec/indices.exists_alias.json index a5e14aabaf..5bb32cb54c 100644 --- a/specification/_json_spec/indices.exists_alias.json +++ b/specification/_json_spec/indices.exists_alias.json @@ -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." 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.field_usage_stats.json b/specification/_json_spec/indices.field_usage_stats.json index e56d4b2672..3ab455d00b 100644 --- a/specification/_json_spec/indices.field_usage_stats.json +++ b/specification/_json_spec/indices.field_usage_stats.json @@ -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." diff --git a/specification/_json_spec/indices.flush.json b/specification/_json_spec/indices.flush.json index e7be5a2abc..789e1d69db 100644 --- a/specification/_json_spec/indices.flush.json +++ b/specification/_json_spec/indices.flush.json @@ -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." diff --git a/specification/_json_spec/indices.forcemerge.json b/specification/_json_spec/indices.forcemerge.json index befcda41a4..07504aea0d 100644 --- a/specification/_json_spec/indices.forcemerge.json +++ b/specification/_json_spec/indices.forcemerge.json @@ -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." diff --git a/specification/_json_spec/indices.get.json b/specification/_json_spec/indices.get.json index 96c81c6a68..658a35b25d 100644 --- a/specification/_json_spec/indices.get.json +++ b/specification/_json_spec/indices.get.json @@ -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" diff --git a/specification/_json_spec/indices.get_alias.json b/specification/_json_spec/indices.get_alias.json index 947eace028..dabd61897c 100644 --- a/specification/_json_spec/indices.get_alias.json +++ b/specification/_json_spec/indices.get_alias.json @@ -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." diff --git a/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index fb8d4fb73c..16fa6e97a1 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -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)" diff --git a/specification/_json_spec/indices.get_data_stream.json b/specification/_json_spec/indices.get_data_stream.json index 646e5844ef..0e4b6483f0 100644 --- a/specification/_json_spec/indices.get_data_stream.json +++ b/specification/_json_spec/indices.get_data_stream.json @@ -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)" diff --git a/specification/_json_spec/indices.get_data_stream_options.json b/specification/_json_spec/indices.get_data_stream_options.json index a94c7e6e3d..0e9bcec19e 100644 --- a/specification/_json_spec/indices.get_data_stream_options.json +++ b/specification/_json_spec/indices.get_data_stream_options.json @@ -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)" diff --git a/specification/_json_spec/indices.get_field_mapping.json b/specification/_json_spec/indices.get_field_mapping.json index 51955706f7..7319ee62e2 100644 --- a/specification/_json_spec/indices.get_field_mapping.json +++ b/specification/_json_spec/indices.get_field_mapping.json @@ -54,7 +54,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." 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 7f3d930470..befbc7375b 100644 --- a/specification/_json_spec/indices.get_mapping.json +++ b/specification/_json_spec/indices.get_mapping.json @@ -39,7 +39,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." @@ -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_settings.json b/specification/_json_spec/indices.get_settings.json index 22d07c3521..02c0ad907a 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -68,7 +68,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." @@ -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.open.json b/specification/_json_spec/indices.open.json index 5c27090e05..6d9d4c1036 100644 --- a/specification/_json_spec/indices.open.json +++ b/specification/_json_spec/indices.open.json @@ -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": "closed", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index bd973f3845..4d0740c553 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -26,7 +26,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)" diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index 5ba8532135..a63c0d5afe 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -26,7 +26,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)" diff --git a/specification/_json_spec/indices.put_mapping.json b/specification/_json_spec/indices.put_mapping.json index 3ce04268d8..a5baf879f8 100644 --- a/specification/_json_spec/indices.put_mapping.json +++ b/specification/_json_spec/indices.put_mapping.json @@ -46,7 +46,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." diff --git a/specification/_json_spec/indices.put_settings.json b/specification/_json_spec/indices.put_settings.json index 60b1e83f76..ba219c1324 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -60,7 +60,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." diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index 8caf083184..d421a48de2 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.recovery.json b/specification/_json_spec/indices.recovery.json index da35b02ae6..a828ca27e0 100644 --- a/specification/_json_spec/indices.recovery.json +++ b/specification/_json_spec/indices.recovery.json @@ -49,7 +49,7 @@ "default": true }, "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." diff --git a/specification/_json_spec/indices.refresh.json b/specification/_json_spec/indices.refresh.json index dac659538d..7549bd5426 100644 --- a/specification/_json_spec/indices.refresh.json +++ b/specification/_json_spec/indices.refresh.json @@ -39,7 +39,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." diff --git a/specification/_json_spec/indices.reload_search_analyzers.json b/specification/_json_spec/indices.reload_search_analyzers.json index b67b5a0771..87d2e016c4 100644 --- a/specification/_json_spec/indices.reload_search_analyzers.json +++ b/specification/_json_spec/indices.reload_search_analyzers.json @@ -33,7 +33,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." diff --git a/specification/_json_spec/indices.remove_block.json b/specification/_json_spec/indices.remove_block.json index 39fc1f3181..a87edc35ff 100644 --- a/specification/_json_spec/indices.remove_block.json +++ b/specification/_json_spec/indices.remove_block.json @@ -20,8 +20,9 @@ "description": "A comma separated list of indices to remove a block from" }, "block": { - "type": "string", - "description": "The block to remove (one of read, write, read_only or metadata)" + "type": "enum", + "description": "The block to remove (one of read, write, read_only or metadata)", + "options": ["metadata", "read", "read_only", "write"] } } } @@ -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." diff --git a/specification/_json_spec/indices.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 2164811a2b..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." @@ -44,7 +48,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 wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression." diff --git a/specification/_json_spec/indices.resolve_index.json b/specification/_json_spec/indices.resolve_index.json index a991093d0b..ff58037c8f 100644 --- a/specification/_json_spec/indices.resolve_index.json +++ b/specification/_json_spec/indices.resolve_index.json @@ -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)" diff --git a/specification/_json_spec/indices.segments.json b/specification/_json_spec/indices.segments.json index e4e02ffcc3..63f1c8b139 100644 --- a/specification/_json_spec/indices.segments.json +++ b/specification/_json_spec/indices.segments.json @@ -39,7 +39,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." diff --git a/specification/_json_spec/indices.shard_stores.json b/specification/_json_spec/indices.shard_stores.json index dd0f8d3449..88b9b0b6ed 100644 --- a/specification/_json_spec/indices.shard_stores.json +++ b/specification/_json_spec/indices.shard_stores.json @@ -43,7 +43,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." diff --git a/specification/_json_spec/indices.stats.json b/specification/_json_spec/indices.stats.json index 87c04f1b5c..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." } @@ -121,7 +133,7 @@ "default": false }, "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." diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index 4e5248b76c..8817c99163 100644 --- a/specification/_json_spec/indices.validate_query.json +++ b/specification/_json_spec/indices.validate_query.json @@ -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." diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index bb9f8e9405..5d156b1608 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -26,8 +26,15 @@ "methods": ["DELETE"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion", + "chat_completion" + ] }, "inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.get.json b/specification/_json_spec/inference.get.json index 8f1aac3482..bfe9edc315 100644 --- a/specification/_json_spec/inference.get.json +++ b/specification/_json_spec/inference.get.json @@ -30,8 +30,15 @@ "methods": ["GET"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion", + "chat_completion" + ] }, "inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index eab827df2b..50ed955c06 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -27,8 +27,15 @@ "methods": ["POST"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion", + "chat_completion" + ] }, "inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put.json b/specification/_json_spec/inference.put.json index cf84d65abd..9e6d6d6854 100644 --- a/specification/_json_spec/inference.put.json +++ b/specification/_json_spec/inference.put.json @@ -27,8 +27,15 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion", + "chat_completion" + ] }, "inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index 51436ccabe..a478059724 100644 --- a/specification/_json_spec/inference.put_alibabacloud.json +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -17,8 +17,14 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "completion", + "rerank", + "space_embedding", + "text_embedding" + ] }, "alibabacloud_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json index a56df49fac..952df022c5 100644 --- a/specification/_json_spec/inference.put_amazonbedrock.json +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "text_embedding"] }, "amazonbedrock_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_amazonsagemaker.json b/specification/_json_spec/inference.put_amazonsagemaker.json index 720a2d3061..6ef568d6f8 100644 --- a/specification/_json_spec/inference.put_amazonsagemaker.json +++ b/specification/_json_spec/inference.put_amazonsagemaker.json @@ -17,8 +17,15 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "text_embedding", + "completion", + "chat_completion", + "sparse_embedding", + "rerank" + ] }, "amazonsagemaker_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json index 176aa145b4..4f3dbe8ecb 100644 --- a/specification/_json_spec/inference.put_anthropic.json +++ b/specification/_json_spec/inference.put_anthropic.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion"] }, "anthropic_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json index 60abd579c2..19c668a8af 100644 --- a/specification/_json_spec/inference.put_azureaistudio.json +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "rerank", "text_embedding"] }, "azureaistudio_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json index d735ecb39e..fc0fc7642e 100644 --- a/specification/_json_spec/inference.put_azureopenai.json +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "text_embedding"] }, "azureopenai_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json index 4867f2224f..4743169541 100644 --- a/specification/_json_spec/inference.put_cohere.json +++ b/specification/_json_spec/inference.put_cohere.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "rerank", "text_embedding"] }, "cohere_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_custom.json b/specification/_json_spec/inference.put_custom.json index d14089cf12..1d8d7bd095 100644 --- a/specification/_json_spec/inference.put_custom.json +++ b/specification/_json_spec/inference.put_custom.json @@ -17,8 +17,14 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "text_embedding", + "sparse_embedding", + "rerank", + "completion" + ] }, "custom_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_deepseek.json b/specification/_json_spec/inference.put_deepseek.json index 8f9044e6cd..d06a9778ca 100644 --- a/specification/_json_spec/inference.put_deepseek.json +++ b/specification/_json_spec/inference.put_deepseek.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "chat_completion"] }, "deepseek_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json index 029ec0d347..91c1784696 100644 --- a/specification/_json_spec/inference.put_elasticsearch.json +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["rerank", "sparse_embedding", "text_embedding"] }, "elasticsearch_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json index 819cb2c629..de124a2f31 100644 --- a/specification/_json_spec/inference.put_elser.json +++ b/specification/_json_spec/inference.put_elser.json @@ -21,8 +21,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["sparse_embedding"] }, "elser_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json index 60b97e68b6..c2e00b1195 100644 --- a/specification/_json_spec/inference.put_googleaistudio.json +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["completion", "text_embedding"] }, "googleaistudio_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json index 4d68e1d4ff..a8b14797fe 100644 --- a/specification/_json_spec/inference.put_googlevertexai.json +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -17,8 +17,14 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "rerank", + "text_embedding", + "completion", + "chat_completion" + ] }, "googlevertexai_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json index b24e9a151e..cd56335880 100644 --- a/specification/_json_spec/inference.put_hugging_face.json +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -17,8 +17,14 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "chat_completion", + "completion", + "rerank", + "text_embedding" + ] }, "huggingface_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json index 33bccb436f..1835e111f1 100644 --- a/specification/_json_spec/inference.put_jinaai.json +++ b/specification/_json_spec/inference.put_jinaai.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["rerank", "text_embedding"] }, "jinaai_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index d0c3786050..de5ecd4e7c 100644 --- a/specification/_json_spec/inference.put_mistral.json +++ b/specification/_json_spec/inference.put_mistral.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["text_embedding", "completion", "chat_completion"] }, "mistral_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_openai.json b/specification/_json_spec/inference.put_openai.json index 15abe5e88a..bb3a92bc87 100644 --- a/specification/_json_spec/inference.put_openai.json +++ b/specification/_json_spec/inference.put_openai.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["chat_completion", "completion", "text_embedding"] }, "openai_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_voyageai.json b/specification/_json_spec/inference.put_voyageai.json index 98a3f7c7c1..4f79496341 100644 --- a/specification/_json_spec/inference.put_voyageai.json +++ b/specification/_json_spec/inference.put_voyageai.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["text_embedding", "rerank"] }, "voyageai_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_watsonx.json b/specification/_json_spec/inference.put_watsonx.json index b127683490..3d5f4db136 100644 --- a/specification/_json_spec/inference.put_watsonx.json +++ b/specification/_json_spec/inference.put_watsonx.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["text_embedding", "chat_completion", "completion"] }, "watsonx_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index 2772c50e89..6fd370c189 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -27,8 +27,15 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion", + "chat_completion" + ] }, "inference_id": { "type": "string", 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 60d8c81fa1..1479d1d766 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"] @@ -30,19 +34,19 @@ "description": "Calculates interim results for the most recent bucket or all buckets within the latency period" }, "start": { - "type": "string", + "type": "date", "description": "When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results" }, "end": { - "type": "string", + "type": "date", "description": "When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results" }, "advance_time": { - "type": "string", + "type": "date", "description": "Advances time to the given value generating results and updating the model for the advanced interval" }, "skip_time": { - "type": "string", + "type": "date", "description": "Skips time to the given value without generating results or updating the model for the skipped interval" } }, diff --git a/specification/_json_spec/ml.get_buckets.json b/specification/_json_spec/ml.get_buckets.json index 9658e2b82a..bd9efc17dc 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -60,12 +60,12 @@ "description": "specifies a max number of buckets to get" }, "start": { - "type": "string", + "type": "date", "default": "-1", "description": "Start time filter for buckets" }, "end": { - "type": "string", + "type": "date", "default": "-1", "description": "End time filter for buckets" }, diff --git a/specification/_json_spec/ml.get_calendar_events.json b/specification/_json_spec/ml.get_calendar_events.json index 2757b7653d..62e9717ce8 100644 --- a/specification/_json_spec/ml.get_calendar_events.json +++ b/specification/_json_spec/ml.get_calendar_events.json @@ -29,7 +29,7 @@ "description": "Get events for the job. When this option is used calendar_id must be '_all'" }, "start": { - "type": "string", + "type": "date", "description": "Get events after this time" }, "end": { diff --git a/specification/_json_spec/ml.get_influencers.json b/specification/_json_spec/ml.get_influencers.json index 84aab83733..b7bbde01ef 100644 --- a/specification/_json_spec/ml.get_influencers.json +++ b/specification/_json_spec/ml.get_influencers.json @@ -41,12 +41,12 @@ "description": "specifies a max number of influencers to get" }, "start": { - "type": "string", + "type": "date", "default": "-1", "description": "start timestamp for the requested influencers" }, "end": { - "type": "string", + "type": "date", "default": "-1", "description": "end timestamp for the requested influencers" }, diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index 5c013a1098..c2dfe63f62 100644 --- a/specification/_json_spec/ml.get_overall_buckets.json +++ b/specification/_json_spec/ml.get_overall_buckets.json @@ -44,11 +44,11 @@ "description": "If true overall buckets that include interim buckets will be excluded" }, "start": { - "type": "string", + "type": "date", "description": "Returns overall buckets with timestamps after this time" }, "end": { - "type": "string", + "type": "date", "description": "Returns overall buckets with timestamps earlier than this time" }, "allow_no_match": { diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index e5a5c6ece2..0b560a39d2 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -41,12 +41,12 @@ "description": "specifies a max number of records to get" }, "start": { - "type": "string", + "type": "date", "default": "-1", "description": "Start time filter for records" }, "end": { - "type": "string", + "type": "date", "default": "-1", "description": "End time filter for records" }, diff --git a/specification/_json_spec/ml.post_data.json b/specification/_json_spec/ml.post_data.json index 9251b1d047..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"] @@ -26,11 +30,11 @@ }, "params": { "reset_start": { - "type": "string", + "type": "date", "description": "Optional parameter to specify the start of the bucket resetting range" }, "reset_end": { - "type": "string", + "type": "date", "description": "Optional parameter to specify the end of the bucket resetting range" } }, diff --git a/specification/_json_spec/ml.preview_datafeed.json b/specification/_json_spec/ml.preview_datafeed.json index e6f29b9963..7efdf78371 100644 --- a/specification/_json_spec/ml.preview_datafeed.json +++ b/specification/_json_spec/ml.preview_datafeed.json @@ -30,11 +30,11 @@ }, "params": { "start": { - "type": "string", + "type": "date", "description": "The start time from where the datafeed preview should begin" }, "end": { - "type": "string", + "type": "date", "description": "The end time when the datafeed preview should stop" } }, diff --git a/specification/_json_spec/ml.put_datafeed.json b/specification/_json_spec/ml.put_datafeed.json index 3446c9bf33..cc7df467e6 100644 --- a/specification/_json_spec/ml.put_datafeed.json +++ b/specification/_json_spec/ml.put_datafeed.json @@ -40,12 +40,16 @@ "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)" }, "expand_wildcards": { - "type": "enum", + "type": "list", "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" diff --git a/specification/_json_spec/ml.put_job.json b/specification/_json_spec/ml.put_job.json index a8754e6fc4..0774e2fbac 100644 --- a/specification/_json_spec/ml.put_job.json +++ b/specification/_json_spec/ml.put_job.json @@ -36,12 +36,16 @@ "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." }, "expand_wildcards": { - "type": "enum", + "type": "list", "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided." diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index e871b3e67b..dd1074ba99 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -26,11 +26,11 @@ }, "params": { "start": { - "type": "string", + "type": "date", "description": "The start time from where the datafeed should begin" }, "end": { - "type": "string", + "type": "date", "description": "The end time when the datafeed should stop. When not set, the datafeed continues in real time" }, "timeout": { diff --git a/specification/_json_spec/ml.update_datafeed.json b/specification/_json_spec/ml.update_datafeed.json index 35bb5ebd3f..6f9f56dc1a 100644 --- a/specification/_json_spec/ml.update_datafeed.json +++ b/specification/_json_spec/ml.update_datafeed.json @@ -40,12 +40,16 @@ "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)" }, "expand_wildcards": { - "type": "enum", + "type": "list", "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" 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 f3f75c911c..0872c4338d 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" }, @@ -81,7 +84,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." 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/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index 7e920df74a..5347293072 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -39,7 +39,7 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "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." diff --git a/specification/_json_spec/rank_eval.json b/specification/_json_spec/rank_eval.json index 56c912f562..b932455b70 100644 --- a/specification/_json_spec/rank_eval.json +++ b/specification/_json_spec/rank_eval.json @@ -40,7 +40,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." 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 02bfd54055..61767d8254 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 f6f8f0d738..f7209a8d09 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" @@ -93,7 +97,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." diff --git a/specification/_json_spec/search_application.post_behavioral_analytics_event.json b/specification/_json_spec/search_application.post_behavioral_analytics_event.json index 477bef30d8..413d20caa8 100644 --- a/specification/_json_spec/search_application.post_behavioral_analytics_event.json +++ b/specification/_json_spec/search_application.post_behavioral_analytics_event.json @@ -25,8 +25,9 @@ "description": "The name of behavioral analytics collection" }, "event_type": { - "type": "string", - "description": "Behavioral analytics event type. Available: page_view, search, search_click" + "type": "enum", + "description": "Behavioral analytics event type. Available: page_view, search, search_click", + "options": ["page_view", "search", "search_click"] } } } diff --git a/specification/_json_spec/search_shards.json b/specification/_json_spec/search_shards.json index 5ad4ed3b5d..f37b96535c 100644 --- a/specification/_json_spec/search_shards.json +++ b/specification/_json_spec/search_shards.json @@ -52,7 +52,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." diff --git a/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index 0841e8d015..a63e6fb338 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" @@ -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." diff --git a/specification/_json_spec/searchable_snapshots.clear_cache.json b/specification/_json_spec/searchable_snapshots.clear_cache.json index 6c644a27cf..289a7e8724 100644 --- a/specification/_json_spec/searchable_snapshots.clear_cache.json +++ b/specification/_json_spec/searchable_snapshots.clear_cache.json @@ -37,7 +37,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." diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 89a943ee11..e65685bb2a 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -66,7 +66,7 @@ "description": "What to do when the update 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."