Skip to content

rest-api-spec: add missing enum options #137522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2025
Merged

rest-api-spec: add missing enum options #137522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de0e86f
rest-api-spec: add missing enum options
pquentin Nov 3, 2025
e12bd03
Allow dots in option values
pquentin Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
17 changes: 16 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
11 changes: 10 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 6 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
10 changes: 9 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
19 changes: 18 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
155 changes: 153 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
8 changes: 7 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
40 changes: 38 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
32 changes: 30 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
Loading