diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index c87ca7db38..890353085f 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 9dbabe8d31..28bf04d66a 100644 --- a/specification/_json_spec/cat.aliases.json +++ b/specification/_json_spec/cat.aliases.json @@ -56,7 +56,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 2d380f021b..02f3ea02e6 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 db6bede741..d429d85c21 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 4cf4c5ddf9..87eca45fe7 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.health.json b/specification/_json_spec/cluster.health.json index 6b2ea60e1e..9e95ae50d3 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 26314372c0..8238585273 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 4be24bec3a..c5258a7f81 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", @@ -96,7 +98,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 42b23e4337..bc69b667fe 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 9d98430437..0baa6d9280 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 898ff7108e..865b1c04a2 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 83bf2369df..115e665f7b 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 4f390cda79..de1f14a5a0 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 c6fd538d61..9b57ad8420 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 3dba2b2787..27191e1d26 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 f62ae51eaa..aaf3bf00a9 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 08b3fdb0fe..3eb64fed1a 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 714951fdc8..024047ea9b 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 06fad82e69..ce2bfb2ee8 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 b1f8cead36..c7bc9a2f34 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 470dd45595..6786080ba0 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 d5be4fd510..aebe1f57c8 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 f93b314161..53bea8f442 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.field_usage_stats.json b/specification/_json_spec/indices.field_usage_stats.json index 20add739c6..486a9e03a1 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 b135a0167f..d07994e84b 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 c8345bdc3b..bf3963b6b4 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 2064c173e3..6302be9ada 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 a814cdd48a..c0696e3634 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 5c103d3c4b..a53915f71c 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 bafc6b2796..25598eee7f 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 f9bf86c711..36a3637350 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 dd99474ae4..13b27de8cf 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_mapping.json b/specification/_json_spec/indices.get_mapping.json index 00ffe33ef6..c2ed91cdde 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." diff --git a/specification/_json_spec/indices.get_settings.json b/specification/_json_spec/indices.get_settings.json index f2a6638813..9178139339 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." diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index 89add1d8c3..2f64f9320e 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"] }, diff --git a/specification/_json_spec/indices.open.json b/specification/_json_spec/indices.open.json index 8ed4b074a3..f9239781fe 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 5e6026aa5d..60c07cb317 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 db2c8364e4..018f270ea3 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 557cc5ed69..97b2c33b43 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 e9d6be4f72..c2456cb7ea 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 6828d56215..dee0d3c8a7 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 156c09023a..b0a56bfe43 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 cd9af6c585..7915b22061 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 02b89d7059..5a29560c35 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.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 366b100980..a243d38e7b 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 4a8f6ddf55..c675b2dfe4 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 c164c00e1b..8af298c496 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 f3f45529df..208ee82a45 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 991777f14c..7a3df689bd 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.unfreeze.json b/specification/_json_spec/indices.unfreeze.json index 90d0f26fab..5a2edc7406 100644 --- a/specification/_json_spec/indices.unfreeze.json +++ b/specification/_json_spec/indices.unfreeze.json @@ -16,8 +16,8 @@ "methods": ["POST"], "parts": { "index": { - "type": "string", - "description": "The name of the index to unfreeze" + "type": "list", + "description": "A comma separated list of indices to remove a block from" } }, "deprecated": { @@ -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": "closed", "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 9ef37bb2eb..fb0d1529f1 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 81c922a000..2551dc3603 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 bc5e3d1b5b..f30163e9b6 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 151d91b5e5..0180888b50 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 2226f2aabe..2b6f711b59 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 388d8edf4b..92efd2e79f 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 b605633bec..79be7be915 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 0a88a359a3..678aff1b21 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 2583c0f191..8c7fbf6cac 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 75d95e71f9..919e781545 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 5a454aee25..efee1ff224 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 98cfad9c27..0042c5b1a9 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 e39884796a..f2641f475f 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 07ed25a2f6..55bc5d3404 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 4bd58f5602..6648388d18 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 71f08f3fc8..450afbfe58 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 bb1af28073..87bb6b867c 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 a4847ca143..ff945bfaed 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 57abe3b5d9..1b07436a3c 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 a7d0fefa4f..af98c27c07 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 b37237cd6e..bee5ed1440 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 13d9a2a4c1..2a954be611 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 69c0768fda..930f805170 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 3e879d6aca..55a2c68ab1 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 b45001a3cd..0d40c1d233 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 16891767c4..613af4619f 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 4b52e4a7cb..c0c71d88d5 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 f5b2fbd52f..673a0b5f1e 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 59219a8466..6f5ef2a538 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 a0750c3379..8fc0066462 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 94f93aead2..a6cdc0fd36 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 41c176efab..3bc24b684a 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.get_trained_models.json b/specification/_json_spec/ml.get_trained_models.json index 3bcb385a0f..b0d37619a2 100644 --- a/specification/_json_spec/ml.get_trained_models.json +++ b/specification/_json_spec/ml.get_trained_models.json @@ -48,7 +48,10 @@ "type": "boolean", "description": "Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.", "default": false, - "deprecated": true + "deprecated": { + "version": "7.10.0", + "description": "This paramater is deprecated in favor of ?include=definition" + } }, "decompress_definition": { "type": "boolean", diff --git a/specification/_json_spec/ml.post_data.json b/specification/_json_spec/ml.post_data.json index 78dea90d28..97fb61c85e 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 ab56407fc2..4572f2dd27 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 eb03213f37..377aa741c3 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 f5af8173b7..49db0d25df 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 3762132513..4f49f71d9a 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 8174ba55fe..8ae4a02aae 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 a4c69f8673..7395064fb2 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 949a801aa6..a0c22e9526 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 1f3a43f352..285a271574 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 4141adec04..f10aa85ec8 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 db8083d648..9891ab3ef9 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 59ab2ef0d7..d1f9926f51 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 1673623ce3..209bd84614 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 31f53db9b6..ebe172148e 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 71d139f615..68c9032b54 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 c85d2da8af..1cbf2c62fd 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 64da8a389a..ac4dc7f6c0 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 750b7001cd..f28be0e477 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 18d7f6229e..ac77f937c7 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 52bbc6fac1..74337c3080 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 6b5d510660..15920d0936 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 c3bfaab632..41ccf7a598 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 f15bfeeafc..591c524c55 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 e220221b60..1ec5285ddc 100644 --- a/specification/_json_spec/search_application.post_behavioral_analytics_event.json +++ b/specification/_json_spec/search_application.post_behavioral_analytics_event.json @@ -21,8 +21,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 13f8df02e9..a7199eebda 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 2a77568e56..2f3d63eed8 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 57d0d9f722..75a47b096b 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 d57aa6147f..8eabe76d1a 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."