Skip to content

Commit c569292

Browse files
pquentinpquentin
committed
rest-api-spec: add missing enum options (elastic#137522)
* rest-api-spec: add missing enum options * Allow dots in option values
1 parent 6a3e650 commit c569292

30 files changed

+856
-36
lines changed

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,15 @@
4242
},
4343
"h": {
4444
"type": "list",
45-
"description": "Comma-separated list of column names to display"
45+
"description": "Comma-separated list of column names to display",
46+
"options": [
47+
"alias",
48+
"index",
49+
"filter",
50+
"routing.index",
51+
"routing.search",
52+
"is_write_index"
53+
]
4654
},
4755
"help": {
4856
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,22 @@
7777
},
7878
"h": {
7979
"type": "list",
80-
"description": "Comma-separated list of column names to display"
80+
"description": "Comma-separated list of column names to display",
81+
"options": [
82+
"shards",
83+
"shards.undesired",
84+
"write_load.forecast",
85+
"disk.indices.forecast",
86+
"disk.indices",
87+
"disk.used",
88+
"disk.avail",
89+
"disk.total",
90+
"disk.percent",
91+
"host",
92+
"ip",
93+
"node",
94+
"node.role"
95+
]
8196
},
8297
"help": {
8398
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,16 @@
5252
},
5353
"h": {
5454
"type": "list",
55-
"description": "Comma-separated list of column names to display"
55+
"description": "Comma-separated list of column names to display",
56+
"options": [
57+
"name",
58+
"version",
59+
"alias_count",
60+
"mapping_count",
61+
"settings_count",
62+
"metadata_count",
63+
"included_in"
64+
]
5665
},
5766
"help": {
5867
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,12 @@
4242
},
4343
"h": {
4444
"type": "list",
45-
"description": "Comma-separated list of column names to display"
45+
"description": "Comma-separated list of column names to display",
46+
"options": [
47+
"epoch",
48+
"timestamp",
49+
"count"
50+
]
4651
},
4752
"help": {
4853
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,15 @@
5454
},
5555
"h": {
5656
"type": "list",
57-
"description": "Comma-separated list of column names to display"
57+
"description": "Comma-separated list of column names to display",
58+
"options": [
59+
"id",
60+
"host",
61+
"ip",
62+
"node",
63+
"field",
64+
"size"
65+
]
5866
},
5967
"help": {
6068
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,24 @@
3030
},
3131
"h": {
3232
"type": "list",
33-
"description": "Comma-separated list of column names to display"
33+
"description": "Comma-separated list of column names to display",
34+
"options": [
35+
"epoch",
36+
"timestamp",
37+
"cluster",
38+
"status",
39+
"node.total",
40+
"node.data",
41+
"shards",
42+
"pri",
43+
"relo",
44+
"init",
45+
"unassign",
46+
"unassign.pri",
47+
"pending_tasks",
48+
"max_task_wait_time",
49+
"active_shards_percent"
50+
]
3451
},
3552
"help": {
3653
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json‎

Lines changed: 153 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,165 @@
5959
},
6060
"h": {
6161
"type": "list",
62-
"description": "Comma-separated list of column names to display"
62+
"description": "Comma-separated list of column names to display",
63+
"options": [
64+
"health",
65+
"status",
66+
"index",
67+
"uuid",
68+
"pri",
69+
"rep",
70+
"docs.count",
71+
"docs.deleted",
72+
"creation.date",
73+
"creation.date.string",
74+
"store.size",
75+
"pri.store.size",
76+
"dataset.size",
77+
"completion.size",
78+
"pri.completion.size",
79+
"fielddata.memory_size",
80+
"pri.fielddata.memory_size",
81+
"fielddata.evictions",
82+
"pri.fielddata.evictions",
83+
"query_cache.memory_size",
84+
"pri.query_cache.memory_size",
85+
"query_cache.evictions",
86+
"pri.query_cache.evictions",
87+
"request_cache.memory_size",
88+
"pri.request_cache.memory_size",
89+
"request_cache.evictions",
90+
"pri.request_cache.evictions",
91+
"request_cache.hit_count",
92+
"pri.request_cache.hit_count",
93+
"request_cache.miss_count",
94+
"pri.request_cache.miss_count",
95+
"flush.total",
96+
"pri.flush.total",
97+
"flush.total_time",
98+
"pri.flush.total_time",
99+
"get.current",
100+
"pri.get.current",
101+
"get.time",
102+
"pri.get.time",
103+
"get.total",
104+
"pri.get.total",
105+
"get.exists_time",
106+
"pri.get.exists_time",
107+
"get.exists_total",
108+
"pri.get.exists_total",
109+
"get.missing_time",
110+
"pri.get.missing_time",
111+
"get.missing_total",
112+
"pri.get.missing_total",
113+
"indexing.delete_current",
114+
"pri.indexing.delete_current",
115+
"indexing.delete_time",
116+
"pri.indexing.delete_time",
117+
"indexing.delete_total",
118+
"pri.indexing.delete_total",
119+
"indexing.index_current",
120+
"pri.indexing.index_current",
121+
"indexing.index_time",
122+
"pri.indexing.index_time",
123+
"indexing.index_total",
124+
"pri.indexing.index_total",
125+
"indexing.index_failed",
126+
"pri.indexing.index_failed",
127+
"indexing.index_failed_due_to_version_conflict",
128+
"pri.indexing.index_failed_due_to_version_conflict",
129+
"merges.current",
130+
"pri.merges.current",
131+
"merges.current_docs",
132+
"pri.merges.current_docs",
133+
"merges.current_size",
134+
"pri.merges.current_size",
135+
"merges.total",
136+
"pri.merges.total",
137+
"merges.total_docs",
138+
"pri.merges.total_docs",
139+
"merges.total_size",
140+
"pri.merges.total_size",
141+
"merges.total_time",
142+
"pri.merges.total_time",
143+
"refresh.total",
144+
"pri.refresh.total",
145+
"refresh.time",
146+
"pri.refresh.time",
147+
"refresh.external_total",
148+
"pri.refresh.external_total",
149+
"refresh.external_time",
150+
"pri.refresh.external_time",
151+
"refresh.listeners",
152+
"pri.refresh.listeners",
153+
"search.fetch_current",
154+
"pri.search.fetch_current",
155+
"search.fetch_time",
156+
"pri.search.fetch_time",
157+
"search.fetch_total",
158+
"pri.search.fetch_total",
159+
"search.open_contexts",
160+
"pri.search.open_contexts",
161+
"search.query_current",
162+
"pri.search.query_current",
163+
"search.query_time",
164+
"pri.search.query_time",
165+
"search.query_total",
166+
"pri.search.query_total",
167+
"search.scroll_current",
168+
"pri.search.scroll_current",
169+
"search.scroll_time",
170+
"pri.search.scroll_time",
171+
"search.scroll_total",
172+
"pri.search.scroll_total",
173+
"segments.count",
174+
"pri.segments.count",
175+
"segments.memory",
176+
"pri.segments.memory",
177+
"segments.index_writer_memory",
178+
"pri.segments.index_writer_memory",
179+
"segments.version_map_memory",
180+
"pri.segments.version_map_memory",
181+
"segments.fixed_bitset_memory",
182+
"pri.segments.fixed_bitset_memory",
183+
"warmer.current",
184+
"pri.warmer.current",
185+
"warmer.total",
186+
"pri.warmer.total",
187+
"warmer.total_time",
188+
"pri.warmer.total_time",
189+
"suggest.current",
190+
"pri.suggest.current",
191+
"suggest.time",
192+
"pri.suggest.time",
193+
"suggest.total",
194+
"pri.suggest.total",
195+
"memory.total",
196+
"pri.memory.total",
197+
"bulk.total_operations",
198+
"pri.bulk.total_operations",
199+
"bulk.total_time",
200+
"pri.bulk.total_time",
201+
"bulk.total_size_in_bytes",
202+
"pri.bulk.total_size_in_bytes",
203+
"bulk.avg_time",
204+
"pri.bulk.avg_time",
205+
"bulk.avg_size_in_bytes",
206+
"pri.bulk.avg_size_in_bytes",
207+
"dense_vector.value_count",
208+
"pri.dense_vector.value_count",
209+
"sparse_vector.value_count",
210+
"pri.sparse_vector.value_count"
211+
]
63212
},
64213
"health": {
65214
"type": "enum",
66215
"options": [
67216
"green",
68217
"yellow",
69-
"red"
218+
"red",
219+
"unknown",
220+
"unavailable"
70221
],
71222
"description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"
72223
},

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@
4040
},
4141
"h": {
4242
"type": "list",
43-
"description": "Comma-separated list of column names to display"
43+
"description": "Comma-separated list of column names to display",
44+
"options": [
45+
"id",
46+
"host",
47+
"ip",
48+
"node"
49+
]
4450
},
4551
"help": {
4652
"type": "boolean",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,25 @@
6060
"h": {
6161
"type": "list",
6262
"default": "create_time,id,state,type",
63-
"description": "Comma-separated list of column names to display"
63+
"description": "Comma-separated list of column names to display",
64+
"options": [
65+
"assignment_explanation",
66+
"create_time",
67+
"description",
68+
"dest_index",
69+
"failure_reason",
70+
"id",
71+
"model_memory_limit",
72+
"node.address",
73+
"node.ephemeral_id",
74+
"node.id",
75+
"node.name",
76+
"progress",
77+
"source_index",
78+
"state",
79+
"type",
80+
"version"
81+
]
6482
},
6583
"help": {
6684
"type": "boolean",
@@ -69,7 +87,25 @@
6987
},
7088
"s": {
7189
"type": "list",
72-
"description": "Comma-separated list of column names or column aliases to sort by"
90+
"description": "Comma-separated list of column names or column aliases to sort by",
91+
"options": [
92+
"assignment_explanation",
93+
"create_time",
94+
"description",
95+
"dest_index",
96+
"failure_reason",
97+
"id",
98+
"model_memory_limit",
99+
"node.address",
100+
"node.ephemeral_id",
101+
"node.id",
102+
"node.name",
103+
"progress",
104+
"source_index",
105+
"state",
106+
"type",
107+
"version"
108+
]
73109
},
74110
"time": {
75111
"type": "enum",

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,21 @@
4848
"h": {
4949
"type": "list",
5050
"default": "['bc', 'id', 'sc', 's']",
51-
"description": "Comma-separated list of column names to display"
51+
"description": "Comma-separated list of column names to display",
52+
"options": [
53+
"ae",
54+
"bc",
55+
"id",
56+
"na",
57+
"ne",
58+
"ni",
59+
"nn",
60+
"sba",
61+
"sc",
62+
"seah",
63+
"st",
64+
"s"
65+
]
5266
},
5367
"help": {
5468
"type": "boolean",
@@ -57,7 +71,21 @@
5771
},
5872
"s": {
5973
"type": "list",
60-
"description": "Comma-separated list of column names or column aliases to sort by"
74+
"description": "Comma-separated list of column names or column aliases to sort by",
75+
"options": [
76+
"ae",
77+
"bc",
78+
"id",
79+
"na",
80+
"ne",
81+
"ni",
82+
"nn",
83+
"sba",
84+
"sc",
85+
"seah",
86+
"st",
87+
"s"
88+
]
6189
},
6290
"time": {
6391
"type": "enum",

0 commit comments

Comments
 (0)