diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index bfb55ef4ba..01d17029ea 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..604fb743b0 100644 --- a/specification/_json_spec/cat.aliases.json +++ b/specification/_json_spec/cat.aliases.json @@ -35,7 +35,15 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "alias", + "index", + "filter", + "routing.index", + "routing.search", + "is_write_index" + ] }, "help": { "type": "boolean", @@ -52,7 +60,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.allocation.json b/specification/_json_spec/cat.allocation.json index 0f41072b13..1fbac9c2c0 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -55,7 +55,22 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "shards", + "shards.undesired", + "write_load.forecast", + "disk.indices.forecast", + "disk.indices", + "disk.used", + "disk.avail", + "disk.total", + "disk.percent", + "host", + "ip", + "node", + "node.role" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index a0726ba991..0b3ec0b119 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -45,7 +45,16 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "name", + "version", + "alias_count", + "mapping_count", + "settings_count", + "metadata_count", + "included_in" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.count.json b/specification/_json_spec/cat.count.json index 360e4d04ce..c53a8ad128 100644 --- a/specification/_json_spec/cat.count.json +++ b/specification/_json_spec/cat.count.json @@ -35,7 +35,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["epoch", "timestamp", "count"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.fielddata.json b/specification/_json_spec/cat.fielddata.json index d99f49cfd0..f44e4b8d8d 100644 --- a/specification/_json_spec/cat.fielddata.json +++ b/specification/_json_spec/cat.fielddata.json @@ -40,7 +40,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["id", "host", "ip", "node", "field", "size"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.health.json b/specification/_json_spec/cat.health.json index 2d421cbfbf..23a917e99e 100644 --- a/specification/_json_spec/cat.health.json +++ b/specification/_json_spec/cat.health.json @@ -25,7 +25,24 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "epoch", + "timestamp", + "cluster", + "status", + "node.total", + "node.data", + "shards", + "pri", + "relo", + "init", + "unassign", + "unassign.pri", + "pending_tasks", + "max_task_wait_time", + "active_shards_percent" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.indices.json b/specification/_json_spec/cat.indices.json index 9cb526b086..877ed7a94a 100644 --- a/specification/_json_spec/cat.indices.json +++ b/specification/_json_spec/cat.indices.json @@ -45,11 +45,160 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "health", + "status", + "index", + "uuid", + "pri", + "rep", + "docs.count", + "docs.deleted", + "creation.date", + "creation.date.string", + "store.size", + "pri.store.size", + "dataset.size", + "completion.size", + "pri.completion.size", + "fielddata.memory_size", + "pri.fielddata.memory_size", + "fielddata.evictions", + "pri.fielddata.evictions", + "query_cache.memory_size", + "pri.query_cache.memory_size", + "query_cache.evictions", + "pri.query_cache.evictions", + "request_cache.memory_size", + "pri.request_cache.memory_size", + "request_cache.evictions", + "pri.request_cache.evictions", + "request_cache.hit_count", + "pri.request_cache.hit_count", + "request_cache.miss_count", + "pri.request_cache.miss_count", + "flush.total", + "pri.flush.total", + "flush.total_time", + "pri.flush.total_time", + "get.current", + "pri.get.current", + "get.time", + "pri.get.time", + "get.total", + "pri.get.total", + "get.exists_time", + "pri.get.exists_time", + "get.exists_total", + "pri.get.exists_total", + "get.missing_time", + "pri.get.missing_time", + "get.missing_total", + "pri.get.missing_total", + "indexing.delete_current", + "pri.indexing.delete_current", + "indexing.delete_time", + "pri.indexing.delete_time", + "indexing.delete_total", + "pri.indexing.delete_total", + "indexing.index_current", + "pri.indexing.index_current", + "indexing.index_time", + "pri.indexing.index_time", + "indexing.index_total", + "pri.indexing.index_total", + "indexing.index_failed", + "pri.indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "pri.indexing.index_failed_due_to_version_conflict", + "merges.current", + "pri.merges.current", + "merges.current_docs", + "pri.merges.current_docs", + "merges.current_size", + "pri.merges.current_size", + "merges.total", + "pri.merges.total", + "merges.total_docs", + "pri.merges.total_docs", + "merges.total_size", + "pri.merges.total_size", + "merges.total_time", + "pri.merges.total_time", + "refresh.total", + "pri.refresh.total", + "refresh.time", + "pri.refresh.time", + "refresh.external_total", + "pri.refresh.external_total", + "refresh.external_time", + "pri.refresh.external_time", + "refresh.listeners", + "pri.refresh.listeners", + "search.fetch_current", + "pri.search.fetch_current", + "search.fetch_time", + "pri.search.fetch_time", + "search.fetch_total", + "pri.search.fetch_total", + "search.open_contexts", + "pri.search.open_contexts", + "search.query_current", + "pri.search.query_current", + "search.query_time", + "pri.search.query_time", + "search.query_total", + "pri.search.query_total", + "search.scroll_current", + "pri.search.scroll_current", + "search.scroll_time", + "pri.search.scroll_time", + "search.scroll_total", + "pri.search.scroll_total", + "segments.count", + "pri.segments.count", + "segments.memory", + "pri.segments.memory", + "segments.index_writer_memory", + "pri.segments.index_writer_memory", + "segments.version_map_memory", + "pri.segments.version_map_memory", + "segments.fixed_bitset_memory", + "pri.segments.fixed_bitset_memory", + "warmer.current", + "pri.warmer.current", + "warmer.total", + "pri.warmer.total", + "warmer.total_time", + "pri.warmer.total_time", + "suggest.current", + "pri.suggest.current", + "suggest.time", + "pri.suggest.time", + "suggest.total", + "pri.suggest.total", + "memory.total", + "pri.memory.total", + "bulk.total_operations", + "pri.bulk.total_operations", + "bulk.total_time", + "pri.bulk.total_time", + "bulk.total_size_in_bytes", + "pri.bulk.total_size_in_bytes", + "bulk.avg_time", + "pri.bulk.avg_time", + "bulk.avg_size_in_bytes", + "pri.bulk.avg_size_in_bytes", + "dense_vector.value_count", + "pri.dense_vector.value_count", + "sparse_vector.value_count", + "pri.sparse_vector.value_count" + ] }, "health": { "type": "enum", - "options": ["green", "yellow", "red"], + "options": ["green", "yellow", "red", "unknown", "unavailable"], "description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status" }, "help": { @@ -82,7 +231,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.master.json b/specification/_json_spec/cat.master.json index d57a92fab8..c80daea3c6 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -35,7 +35,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["id", "host", "ip", "node"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.ml_data_frame_analytics.json b/specification/_json_spec/cat.ml_data_frame_analytics.json index 240d036f68..04d4c25d6f 100644 --- a/specification/_json_spec/cat.ml_data_frame_analytics.json +++ b/specification/_json_spec/cat.ml_data_frame_analytics.json @@ -46,7 +46,25 @@ "h": { "type": "list", "default": "create_time,id,state,type", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "assignment_explanation", + "create_time", + "description", + "dest_index", + "failure_reason", + "id", + "model_memory_limit", + "node.address", + "node.ephemeral_id", + "node.id", + "node.name", + "progress", + "source_index", + "state", + "type", + "version" + ] }, "help": { "type": "boolean", @@ -55,7 +73,25 @@ }, "s": { "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" + "description": "Comma-separated list of column names or column aliases to sort by", + "options": [ + "assignment_explanation", + "create_time", + "description", + "dest_index", + "failure_reason", + "id", + "model_memory_limit", + "node.address", + "node.ephemeral_id", + "node.id", + "node.name", + "progress", + "source_index", + "state", + "type", + "version" + ] }, "time": { "type": "enum", diff --git a/specification/_json_spec/cat.ml_datafeeds.json b/specification/_json_spec/cat.ml_datafeeds.json index 3a370e943b..344fc9929e 100644 --- a/specification/_json_spec/cat.ml_datafeeds.json +++ b/specification/_json_spec/cat.ml_datafeeds.json @@ -41,7 +41,21 @@ "h": { "type": "list", "default": "['bc', 'id', 'sc', 's']", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "ae", + "bc", + "id", + "na", + "ne", + "ni", + "nn", + "sba", + "sc", + "seah", + "st", + "s" + ] }, "help": { "type": "boolean", @@ -50,7 +64,21 @@ }, "s": { "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" + "description": "Comma-separated list of column names or column aliases to sort by", + "options": [ + "ae", + "bc", + "id", + "na", + "ne", + "ni", + "nn", + "sba", + "sc", + "seah", + "st", + "s" + ] }, "time": { "type": "enum", diff --git a/specification/_json_spec/cat.ml_jobs.json b/specification/_json_spec/cat.ml_jobs.json index 1e1ff05b88..6e0ec311db 100644 --- a/specification/_json_spec/cat.ml_jobs.json +++ b/specification/_json_spec/cat.ml_jobs.json @@ -46,7 +46,69 @@ "h": { "type": "list", "default": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "assignment_explanation", + "buckets.count", + "buckets.time.exp_avg", + "buckets.time.exp_avg_hour", + "buckets.time.max", + "buckets.time.min", + "buckets.time.total", + "data.buckets", + "data.earliest_record", + "data.empty_buckets", + "data.input_bytes", + "data.input_fields", + "data.input_records", + "data.invalid_dates", + "data.last", + "data.last_empty_bucket", + "data.last_sparse_bucket", + "data.latest_record", + "data.missing_fields", + "data.out_of_order_timestamps", + "data.processed_fields", + "data.processed_records", + "data.sparse_buckets", + "forecasts.memory.avg", + "forecasts.memory.max", + "forecasts.memory.min", + "forecasts.memory.total", + "forecasts.records.avg", + "forecasts.records.max", + "forecasts.records.min", + "forecasts.records.total", + "forecasts.time.avg", + "forecasts.time.max", + "forecasts.time.min", + "forecasts.time.total", + "forecasts.total", + "id", + "model.bucket_allocation_failures", + "model.by_fields", + "model.bytes", + "model.bytes_exceeded", + "model.categorization_status", + "model.categorized_doc_count", + "model.dead_category_count", + "model.failed_category_count", + "model.frequent_category_count", + "model.log_time", + "model.memory_limit", + "model.memory_status", + "model.over_fields", + "model.partition_fields", + "model.rare_category_count", + "model.timestamp", + "model.total_category_count", + "node.address", + "node.ephemeral_id", + "node.id", + "node.name", + "opened_time", + "state" + ] }, "help": { "type": "boolean", @@ -55,7 +117,69 @@ }, "s": { "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" + "description": "Comma-separated list of column names or column aliases to sort by", + "options": [ + "assignment_explanation", + "buckets.count", + "buckets.time.exp_avg", + "buckets.time.exp_avg_hour", + "buckets.time.max", + "buckets.time.min", + "buckets.time.total", + "data.buckets", + "data.earliest_record", + "data.empty_buckets", + "data.input_bytes", + "data.input_fields", + "data.input_records", + "data.invalid_dates", + "data.last", + "data.last_empty_bucket", + "data.last_sparse_bucket", + "data.latest_record", + "data.missing_fields", + "data.out_of_order_timestamps", + "data.processed_fields", + "data.processed_records", + "data.sparse_buckets", + "forecasts.memory.avg", + "forecasts.memory.max", + "forecasts.memory.min", + "forecasts.memory.total", + "forecasts.records.avg", + "forecasts.records.max", + "forecasts.records.min", + "forecasts.records.total", + "forecasts.time.avg", + "forecasts.time.max", + "forecasts.time.min", + "forecasts.time.total", + "forecasts.total", + "id", + "model.bucket_allocation_failures", + "model.by_fields", + "model.bytes", + "model.bytes_exceeded", + "model.categorization_status", + "model.categorized_doc_count", + "model.dead_category_count", + "model.failed_category_count", + "model.frequent_category_count", + "model.log_time", + "model.memory_limit", + "model.memory_status", + "model.over_fields", + "model.partition_fields", + "model.rare_category_count", + "model.timestamp", + "model.total_category_count", + "node.address", + "node.ephemeral_id", + "node.id", + "node.name", + "opened_time", + "state" + ] }, "time": { "type": "enum", diff --git a/specification/_json_spec/cat.ml_trained_models.json b/specification/_json_spec/cat.ml_trained_models.json index f6a7396972..d23bdb9467 100644 --- a/specification/_json_spec/cat.ml_trained_models.json +++ b/specification/_json_spec/cat.ml_trained_models.json @@ -55,7 +55,23 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "create_time", + "created_by", + "data_frame_analytics_id", + "description", + "heap_size", + "id", + "ingest.count", + "ingest.current", + "ingest.failed", + "ingest.pipelines", + "ingest.time", + "license", + "operations", + "version" + ] }, "help": { "type": "boolean", @@ -64,7 +80,23 @@ }, "s": { "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" + "description": "Comma-separated list of column names or column aliases to sort by", + "options": [ + "create_time", + "created_by", + "data_frame_analytics_id", + "description", + "heap_size", + "id", + "ingest.count", + "ingest.current", + "ingest.failed", + "ingest.pipelines", + "ingest.time", + "license", + "operations", + "version" + ] }, "time": { "type": "enum", diff --git a/specification/_json_spec/cat.nodeattrs.json b/specification/_json_spec/cat.nodeattrs.json index 0bd62a78d9..8a19b07b15 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -35,7 +35,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["node", "id", "pid", "host", "ip", "port", "attr", "value"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.nodes.json b/specification/_json_spec/cat.nodes.json index 4e687f2e4e..80d8a2805f 100644 --- a/specification/_json_spec/cat.nodes.json +++ b/specification/_json_spec/cat.nodes.json @@ -41,7 +41,99 @@ "h": { "type": "list", "default": "ip,hp,rp,r,m,n,cpu,l", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "build", + "completion.size", + "cpu", + "disk.avail", + "disk.total", + "disk.used", + "disk.used_percent", + "fielddata.evictions", + "fielddata.memory_size", + "file_desc.current", + "file_desc.max", + "file_desc.percent", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "heap.current", + "heap.max", + "heap.percent", + "http_address", + "id", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_time", + "indexing.index_total", + "ip", + "jdk", + "load_1m", + "load_5m", + "load_15m", + "available_processors", + "mappings.total_count", + "mappings.total_estimated_overhead_in_bytes", + "master", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "name", + "node.role", + "pid", + "port", + "query_cache.memory_size", + "query_cache.evictions", + "query_cache.hit_count", + "query_cache.miss_count", + "ram.current", + "ram.max", + "ram.percent", + "refresh.total", + "refresh.time", + "request_cache.memory_size", + "request_cache.evictions", + "request_cache.hit_count", + "request_cache.miss_count", + "script.compilations", + "script.cache_evictions", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "shard_stats.total_count", + "suggest.current", + "suggest.time", + "suggest.total", + "uptime", + "version" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.pending_tasks.json b/specification/_json_spec/cat.pending_tasks.json index 8db95f12b2..fae64c8806 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -35,7 +35,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["insertOrder", "timeInQueue", "priority", "source"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index 77d44dd75a..b17f5c2454 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -35,7 +35,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["id", "name", "component", "version", "description"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.recovery.json b/specification/_json_spec/cat.recovery.json index bf9a513cc8..17d549654e 100644 --- a/specification/_json_spec/cat.recovery.json +++ b/specification/_json_spec/cat.recovery.json @@ -51,7 +51,35 @@ "h": { "type": "list", "default": "ip,hp,rp,r,m,n,cpu,l", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "index", + "shard", + "start_time", + "start_time_millis", + "stop_time", + "stop_time_millis", + "time", + "type", + "stage", + "source_host", + "source_node", + "target_host", + "target_node", + "repository", + "snapshot", + "files", + "files_recovered", + "files_percent", + "files_total", + "bytes", + "bytes_recovered", + "bytes_percent", + "bytes_total", + "translog_ops", + "translog_ops_recovered", + "translog_ops_percent" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index 9e37e9b195..815c390870 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -51,7 +51,24 @@ "h": { "type": "list", "default": "ip,hp,rp,r,m,n,cpu,l", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "index", + "shard", + "prirep", + "ip", + "segment", + "generation", + "docs.count", + "docs.deleted", + "size", + "size.memory", + "committed", + "searchable", + "version", + "compound", + "id" + ] }, "help": { "type": "boolean", @@ -88,7 +105,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/cat.shards.json b/specification/_json_spec/cat.shards.json index e753db39f3..c839f2e02b 100644 --- a/specification/_json_spec/cat.shards.json +++ b/specification/_json_spec/cat.shards.json @@ -45,7 +45,79 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "completion.size", + "dataset.size", + "dense_vector.value_count", + "docs", + "fielddata.evictions", + "fielddata.memory_size", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "id", + "index", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_failed", + "indexing.index_time", + "indexing.index_total", + "ip", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "node", + "prirep", + "query_cache.evictions", + "query_cache.memory_size", + "recoverysource.type", + "refresh.time", + "refresh.total", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "seq_no.global_checkpoint", + "seq_no.local_checkpoint", + "seq_no.max", + "shard", + "dsparse_vector.value_count", + "state", + "store", + "suggest.current", + "suggest.time", + "suggest.total", + "sync_id", + "unassigned.at", + "unassigned.details", + "unassigned.for", + "unassigned.reason" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 9733a93bf0..24639f326e 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -46,7 +46,22 @@ "h": { "type": "list", "default": "ip,hp,rp,r,m,n,cpu,l", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "id", + "repository", + "status", + "start_epoch", + "start_time", + "end_epoch", + "end_time", + "duration", + "indices", + "successful_shards", + "failed_shards", + "total_shards", + "reason" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index 0d952f290f..113ec70f9a 100644 --- a/specification/_json_spec/cat.tasks.json +++ b/specification/_json_spec/cat.tasks.json @@ -42,7 +42,24 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "id", + "action", + "task_id", + "parent_task_id", + "type", + "start_time", + "timestamp", + "running_time_ns", + "running_time", + "node_id", + "ip", + "port", + "node", + "version", + "x_opaque_id" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.templates.json b/specification/_json_spec/cat.templates.json index fc69b211b2..c7bf203bba 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -45,7 +45,8 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": ["name", "index_patterns", "order", "version", "composed_of"] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index 4b72a21f2c..36b9188615 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -50,7 +50,29 @@ }, "h": { "type": "list", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "active", + "completed", + "core", + "ephemeral_id", + "host", + "ip", + "keep_alive", + "largest", + "max", + "name", + "node_id", + "node_name", + "pid", + "pool_size", + "port", + "queue", + "queue_size", + "rejected", + "size", + "type" + ] }, "help": { "type": "boolean", diff --git a/specification/_json_spec/cat.transforms.json b/specification/_json_spec/cat.transforms.json index 99d93b1eb5..3b3bccaab0 100644 --- a/specification/_json_spec/cat.transforms.json +++ b/specification/_json_spec/cat.transforms.json @@ -51,7 +51,42 @@ "h": { "type": "list", "default": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state", - "description": "Comma-separated list of column names to display" + "description": "Comma-separated list of column names to display", + "options": [ + "changes_last_detection_time", + "checkpoint", + "checkpoint_duration_time_exp_avg", + "checkpoint_progress", + "create_time", + "delete_time", + "description", + "dest_index", + "documents_deleted", + "documents_indexed", + "docs_per_second", + "documents_processed", + "frequency", + "id", + "index_failure", + "index_time", + "index_total", + "indexed_documents_exp_avg", + "last_search_time", + "max_page_search_size", + "pages_processed", + "pipeline", + "processed_documents_exp_avg", + "processing_time", + "reason", + "search_failure", + "search_time", + "search_total", + "source_index", + "state", + "transform_type", + "trigger_count", + "version" + ] }, "help": { "type": "boolean", @@ -60,7 +95,42 @@ }, "s": { "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" + "description": "Comma-separated list of column names or column aliases to sort by", + "options": [ + "changes_last_detection_time", + "checkpoint", + "checkpoint_duration_time_exp_avg", + "checkpoint_progress", + "create_time", + "delete_time", + "description", + "dest_index", + "documents_deleted", + "documents_indexed", + "docs_per_second", + "documents_processed", + "frequency", + "id", + "index_failure", + "index_time", + "index_total", + "indexed_documents_exp_avg", + "last_search_time", + "max_page_search_size", + "pages_processed", + "pipeline", + "processed_documents_exp_avg", + "processing_time", + "reason", + "search_failure", + "search_time", + "search_total", + "source_index", + "state", + "transform_type", + "trigger_count", + "version" + ] }, "time": { "type": "enum", diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index 72cf6c59df..a07edf9920 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -23,7 +23,10 @@ "scroll_id": { "type": "list", "description": "A comma-separated list of scroll IDs to clear", - "deprecated": true + "deprecated": { + "version": "7.0.0", + "description": "A scroll id can be quite large and should be specified as part of the body" + } } }, "deprecated": { diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index 0ce28f607f..cbd6e21f7f 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -30,7 +30,10 @@ "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { - "deprecated": true, + "deprecated": { + "version": "9.0.0", + "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." + }, "type": "boolean", "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" diff --git a/specification/_json_spec/cluster.get_component_template.json b/specification/_json_spec/cluster.get_component_template.json index 8c18bfc80f..3d17770164 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -34,7 +34,10 @@ "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { - "deprecated": true, + "deprecated": { + "version": "9.0.0", + "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." + }, "type": "boolean", "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" diff --git a/specification/_json_spec/cluster.health.json b/specification/_json_spec/cluster.health.json index 55c9036715..747186bab3 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." @@ -81,7 +81,7 @@ }, "wait_for_status": { "type": "enum", - "options": ["green", "yellow", "red"], + "options": ["green", "yellow", "red", "unknown", "unavailable"], "description": "Wait until cluster is in a specific state" } } diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 41f86859c0..fbb0c1fb96 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -36,17 +36,10 @@ }, "metric": { "type": "list", - "options": [ - "_all", - "blocks", - "metadata", - "nodes", - "none", - "routing_table", - "master_node", - "version" - ], - "default": "all", + "deprecated": { + "version": "8.6.0", + "description": "This parameter has no effect; its use will be forbidden in a future version." + }, "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index 265ba6c010..8264b73f4c 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -24,6 +24,7 @@ "options": [ "_all", "blocks", + "customs", "metadata", "nodes", "routing_table", @@ -48,6 +49,7 @@ "options": [ "_all", "blocks", + "customs", "metadata", "nodes", "routing_table", @@ -63,7 +65,10 @@ }, "params": { "local": { - "deprecated": true, + "deprecated": { + "version": "9.0.0", + "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." + }, "type": "boolean", "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" @@ -97,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/connector.sync_job_list.json b/specification/_json_spec/connector.sync_job_list.json index 0c67e9cbab..74f032deb4 100644 --- a/specification/_json_spec/connector.sync_job_list.json +++ b/specification/_json_spec/connector.sync_job_list.json @@ -47,7 +47,8 @@ }, "job_type": { "type": "list", - "description": "A comma-separated list of job types" + "description": "A comma-separated list of job types", + "options": ["full", "incremental", "access_control"] } } } diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index 8581ac3ef2..945c99b321 100644 --- a/specification/_json_spec/count.json +++ b/specification/_json_spec/count.json @@ -35,6 +35,10 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" @@ -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 d77e88bcab..ee10aff380 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 c25c9cf35e..92dc2d6501 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 1ae6d2794f..5d32a41f50 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 fb5bc29308..152f7f19bd 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..ed532c0de7 100644 --- a/specification/_json_spec/indices.get.json +++ b/specification/_json_spec/indices.get.json @@ -40,15 +40,15 @@ "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", + "default": "['aliases', 'mappings', 'settings']", "description": "Return only information on specified index features" }, "flat_settings": { 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 362fa41a71..db1065772e 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 5f087ca80b..3f60c1d37b 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 9d7f96094d..739271c5c3 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -6,6 +6,10 @@ }, "stability": "stable", "visibility": "public", + "deprecated": { + "version": "7.8.0", + "description": "Legacy index templates are deprecated in favor of composable templates" + }, "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/indices.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 0ac662fc50..69c536ba46 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)" @@ -41,7 +41,7 @@ "default": true }, "mode": { - "type": "enum", + "type": "list", "options": ["standard", "time_series", "logsdb", "lookup"], "description": "Filter indices by index mode. Comma-separated list of IndexMode. Empty means no filter." }, 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 33eda568f8..a3a9b18ae2 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 700fc4dbb7..10caf0d324 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 8e6e2744b9..33c3fcd21e 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_ai21.json b/specification/_json_spec/inference.put_ai21.json index 7dc80f0556..baa1a68c1b 100644 --- a/specification/_json_spec/inference.put_ai21.json +++ b/specification/_json_spec/inference.put_ai21.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"] }, "ai21_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index ca23f1688f..781a38a358 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 e5ee37a1a1..d939737cb0 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 76e39314f5..4028fb708a 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 29fde5aa09..85af682c0c 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 db65647248..e185e27a98 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 1b33ee4645..f61b77b849 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_contextualai.json b/specification/_json_spec/inference.put_contextualai.json index 3b60637840..e447af64f4 100644 --- a/specification/_json_spec/inference.put_contextualai.json +++ b/specification/_json_spec/inference.put_contextualai.json @@ -17,8 +17,9 @@ "methods": ["PUT"], "parts": { "task_type": { - "type": "string", - "description": "The task type" + "type": "enum", + "description": "The task type", + "options": ["rerank"] }, "contextualai_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 6864e95b54..cd221c1d22 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 a415ef0537..591e869302 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 d5998e4516..a5b1dd8eae 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 1641a5b043..d7347db5d2 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 7f806ce6fa..b1fc502a86 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 1b6aab3bf7..2686ffc6b5 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 799f023a46..238051223c 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_llama.json b/specification/_json_spec/inference.put_llama.json index 03c8fb2336..729e32e046 100644 --- a/specification/_json_spec/inference.put_llama.json +++ b/specification/_json_spec/inference.put_llama.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"] }, "llama_inference_id": { "type": "string", diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index 0372a6a606..d0786e27ef 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 2e21dee986..aafec84a9f 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 3639bde22f..5400fbfc0c 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 77a79adc4a..d08dc87c58 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 be8280491e..4ef5b8f126 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 61be07dd82..fd202e27fe 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -6,6 +6,10 @@ }, "stability": "stable", "visibility": "public", + "deprecated": { + "version": "9.1.0", + "description": "Forcing any buffered data to be processed is deprecated, in a future major version a datafeed will be required." + }, "headers": { "accept": ["application/json"], "content_type": ["application/json"] @@ -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 68e4655b41..3c47e85f1b 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 d794aae6d9..56bee520cc 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 79917afa60..056955ad0b 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 9d4dde88ef..4fa5fdc4a5 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 0dc8a49343..6e904fd418 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 a18360b843..fd49667fb4 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -72,7 +72,10 @@ }, "ignore_throttled": { "type": "boolean", - "deprecated": true, + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "default": false, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, @@ -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.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index f998d43e79..f9a9ff6ded 100644 --- a/specification/_json_spec/nodes.hot_threads.json +++ b/specification/_json_spec/nodes.hot_threads.json @@ -50,13 +50,13 @@ }, "type": { "type": "enum", - "options": ["cpu", "wait", "block", "mem"], + "options": ["cpu", "wait", "block", "gpu", "mem"], "default": "cpu", "description": "The type to sample (default: cpu)" }, "sort": { "type": "enum", - "options": ["cpu", "total"], + "options": ["cpu", "wait", "block", "gpu", "mem"], "description": "The sort order for 'cpu' type (default: total)" }, "timeout": { 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 a3b93615a9..87061ffb38 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 177901e371..3f54a6f6f0 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -23,7 +23,10 @@ "scroll_id": { "type": "string", "description": "The scroll ID", - "deprecated": true + "deprecated": { + "version": "7.0.0", + "description": "A scroll id can be quite large and should be specified as part of the body" + } } }, "deprecated": { @@ -40,6 +43,10 @@ "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "scroll_id": { + "deprecated": { + "version": "7.0.0", + "description": "A scroll id can be quite large and should be specified as part of the body" + }, "type": "string", "description": "The scroll ID for scrolled search" }, diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 89985d7dd3..a73d6ec616 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -83,6 +83,10 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" @@ -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 6730e75548..9aeb0386c9 100644 --- a/specification/_json_spec/search_template.json +++ b/specification/_json_spec/search_template.json @@ -35,6 +35,10 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { + "deprecated": { + "version": "7.16.0", + "description": "This parameter is deprecated because frozen indices have been deprecated." + }, "type": "boolean", "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" @@ -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/snapshot.get.json b/specification/_json_spec/snapshot.get.json index b14bc9afff..cfd2b03de0 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -102,7 +102,14 @@ }, "state": { "type": "list", - "description": "Filter snapshots by a comma-separated list of states. Valid state values are 'SUCCESS', 'IN_PROGRESS', 'FAILED', 'PARTIAL', or 'INCOMPATIBLE'." + "description": "Filter snapshots by a comma-separated list of states. Valid state values are 'SUCCESS', 'IN_PROGRESS', 'FAILED', 'PARTIAL', or 'INCOMPATIBLE'.", + "options": [ + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL", + "INCOMPATIBLE" + ] } } } diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 325feca2b1..70291d36a3 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."