diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json index c1efcdca5928a..b355ef7ac75a6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json @@ -42,7 +42,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", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json index fd8b4f921a4d4..78afe8602b78c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json @@ -77,7 +77,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json index aadd6985a09bf..70617a207f2d7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json @@ -52,7 +52,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json index 9998ce054050f..a804190738d4c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json @@ -42,7 +42,12 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json index 4c1578ccb53ad..066602a54e3f1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json @@ -54,7 +54,15 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json index ef696e2872fae..d0ce3b29f8992 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json @@ -30,7 +30,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json index ff01d97d4b535..847ea21cea3ea 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json @@ -59,14 +59,165 @@ }, "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" + "red", + "unknown", + "unavailable" ], "description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status" }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json index 7c05d556b6d5a..aad95509252ed 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json @@ -40,7 +40,13 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json index 96d4803c2a3e1..52c61d532a5d8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json @@ -60,7 +60,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", @@ -69,7 +87,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json index 4fd8d0756ab0a..13153c79ad31b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json @@ -48,7 +48,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", @@ -57,7 +71,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json index 5a5d901e69500..dbd852324fddc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json @@ -60,7 +60,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", @@ -69,7 +131,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json index 0dad824e71539..26ea880cc0042 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json @@ -69,7 +69,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", @@ -78,7 +94,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json index ad80e6fe83d1b..54ac3914b1fae 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json @@ -40,7 +40,17 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json index 24399a8d06c53..6b74e3df39acd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json @@ -53,7 +53,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json index 1e0d7c81b31fe..6e685671a95ef 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json @@ -40,7 +40,13 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json index a3dfdc6046c2f..ae98cedb54c5f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json @@ -40,7 +40,14 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json index 9a80086c7dd45..f07397035c33f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json @@ -65,7 +65,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json index 2977e2e38fef2..f1dcaa9c17ab8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json @@ -65,7 +65,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", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json index 15842253df81c..82f7034edc8ca 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json @@ -59,7 +59,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json index c5061fb1b8e71..a7258760a2bd5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json @@ -53,7 +53,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json index 79c0960054c63..87d5a63764a2a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json @@ -47,7 +47,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json index 34c43942cb828..27a098b2335b0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json @@ -52,7 +52,14 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json index 46218f66d754f..10ef5569bd37d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json @@ -65,7 +65,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/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json index 4b135b880eab4..b5abcd851b56a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json @@ -58,7 +58,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", @@ -67,7 +102,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/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json index 041194fc3d5cc..6c4e00af144c2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json @@ -107,7 +107,9 @@ "options": [ "green", "yellow", - "red" + "red", + "unknown", + "unavailable" ], "description": "Wait until cluster is in a specific state" } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_list.json b/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_list.json index 5661ab110243c..7f5b3ae751ec3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_list.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_list.json @@ -51,7 +51,12 @@ }, "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/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json index 6a37b080965d1..65a4958d0b5d8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json @@ -62,7 +62,7 @@ "mappings", "settings" ], - "default": "aliases,mappings,settings", + "default": "['aliases', 'mappings', 'settings']", "description": "Return only information on specified index features" }, "flat_settings": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json index 6c03c512bfbb0..c49342fc352e6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json @@ -60,6 +60,7 @@ "cpu", "wait", "block", + "gpu", "mem" ], "default": "cpu", @@ -69,7 +70,10 @@ "type": "enum", "options": [ "cpu", - "total" + "wait", + "block", + "gpu", + "mem" ], "description": "The sort order for 'cpu' type (default: total)" }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json index d799ad3d33b72..6bd68c043e869 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json @@ -109,7 +109,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/rest-api-spec/src/main/resources/schema.json b/rest-api-spec/src/main/resources/schema.json index 1aa0890cc87b2..80b74a70087df 100644 --- a/rest-api-spec/src/main/resources/schema.json +++ b/rest-api-spec/src/main/resources/schema.json @@ -259,7 +259,7 @@ "type": "array", "items": { "type": "string", - "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$" + "pattern": "^[_a-zA-Z][_a-zA-Z0-9.]*$" }, "title": "Valid options when type is an enum" },