Skip to content

Commit cccee92

Browse files
github-actions[bot]pquentin
github-actions[bot]
and
pquentin
authored
Update rest-api-spec (#5672)
Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
1 parent 9993e6a commit cccee92

File tree

109 files changed

+1007
-155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+1007
-155
lines changed

‎specification/_json_spec/async_search.submit.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
"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)"
107107
},
108108
"expand_wildcards": {
109-
"type": "enum",
109+
"type": "list",
110110
"options": ["open", "closed", "hidden", "none", "all"],
111111
"default": "open",
112112
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

‎specification/_json_spec/cat.aliases.json‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@
3535
},
3636
"h": {
3737
"type": "list",
38-
"description": "Comma-separated list of column names to display"
38+
"description": "Comma-separated list of column names to display",
39+
"options": [
40+
"alias",
41+
"index",
42+
"filter",
43+
"routing.index",
44+
"routing.search",
45+
"is_write_index"
46+
]
3947
},
4048
"help": {
4149
"type": "boolean",
@@ -52,7 +60,7 @@
5260
"default": false
5361
},
5462
"expand_wildcards": {
55-
"type": "enum",
63+
"type": "list",
5664
"options": ["open", "closed", "hidden", "none", "all"],
5765
"default": "all",
5866
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

‎specification/_json_spec/cat.allocation.json‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,22 @@
5555
},
5656
"h": {
5757
"type": "list",
58-
"description": "Comma-separated list of column names to display"
58+
"description": "Comma-separated list of column names to display",
59+
"options": [
60+
"shards",
61+
"shards.undesired",
62+
"write_load.forecast",
63+
"disk.indices.forecast",
64+
"disk.indices",
65+
"disk.used",
66+
"disk.avail",
67+
"disk.total",
68+
"disk.percent",
69+
"host",
70+
"ip",
71+
"node",
72+
"node.role"
73+
]
5974
},
6075
"help": {
6176
"type": "boolean",

‎specification/_json_spec/cat.component_templates.json‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,16 @@
4545
},
4646
"h": {
4747
"type": "list",
48-
"description": "Comma-separated list of column names to display"
48+
"description": "Comma-separated list of column names to display",
49+
"options": [
50+
"name",
51+
"version",
52+
"alias_count",
53+
"mapping_count",
54+
"settings_count",
55+
"metadata_count",
56+
"included_in"
57+
]
4958
},
5059
"help": {
5160
"type": "boolean",

‎specification/_json_spec/cat.count.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@
3535
},
3636
"h": {
3737
"type": "list",
38-
"description": "Comma-separated list of column names to display"
38+
"description": "Comma-separated list of column names to display",
39+
"options": ["epoch", "timestamp", "count"]
3940
},
4041
"help": {
4142
"type": "boolean",

‎specification/_json_spec/cat.fielddata.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@
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": ["id", "host", "ip", "node", "field", "size"]
4445
},
4546
"help": {
4647
"type": "boolean",

‎specification/_json_spec/cat.health.json‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,24 @@
2525
},
2626
"h": {
2727
"type": "list",
28-
"description": "Comma-separated list of column names to display"
28+
"description": "Comma-separated list of column names to display",
29+
"options": [
30+
"epoch",
31+
"timestamp",
32+
"cluster",
33+
"status",
34+
"node.total",
35+
"node.data",
36+
"shards",
37+
"pri",
38+
"relo",
39+
"init",
40+
"unassign",
41+
"unassign.pri",
42+
"pending_tasks",
43+
"max_task_wait_time",
44+
"active_shards_percent"
45+
]
2946
},
3047
"help": {
3148
"type": "boolean",

‎specification/_json_spec/cat.indices.json‎

Lines changed: 152 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,160 @@
4545
},
4646
"h": {
4747
"type": "list",
48-
"description": "Comma-separated list of column names to display"
48+
"description": "Comma-separated list of column names to display",
49+
"options": [
50+
"health",
51+
"status",
52+
"index",
53+
"uuid",
54+
"pri",
55+
"rep",
56+
"docs.count",
57+
"docs.deleted",
58+
"creation.date",
59+
"creation.date.string",
60+
"store.size",
61+
"pri.store.size",
62+
"dataset.size",
63+
"completion.size",
64+
"pri.completion.size",
65+
"fielddata.memory_size",
66+
"pri.fielddata.memory_size",
67+
"fielddata.evictions",
68+
"pri.fielddata.evictions",
69+
"query_cache.memory_size",
70+
"pri.query_cache.memory_size",
71+
"query_cache.evictions",
72+
"pri.query_cache.evictions",
73+
"request_cache.memory_size",
74+
"pri.request_cache.memory_size",
75+
"request_cache.evictions",
76+
"pri.request_cache.evictions",
77+
"request_cache.hit_count",
78+
"pri.request_cache.hit_count",
79+
"request_cache.miss_count",
80+
"pri.request_cache.miss_count",
81+
"flush.total",
82+
"pri.flush.total",
83+
"flush.total_time",
84+
"pri.flush.total_time",
85+
"get.current",
86+
"pri.get.current",
87+
"get.time",
88+
"pri.get.time",
89+
"get.total",
90+
"pri.get.total",
91+
"get.exists_time",
92+
"pri.get.exists_time",
93+
"get.exists_total",
94+
"pri.get.exists_total",
95+
"get.missing_time",
96+
"pri.get.missing_time",
97+
"get.missing_total",
98+
"pri.get.missing_total",
99+
"indexing.delete_current",
100+
"pri.indexing.delete_current",
101+
"indexing.delete_time",
102+
"pri.indexing.delete_time",
103+
"indexing.delete_total",
104+
"pri.indexing.delete_total",
105+
"indexing.index_current",
106+
"pri.indexing.index_current",
107+
"indexing.index_time",
108+
"pri.indexing.index_time",
109+
"indexing.index_total",
110+
"pri.indexing.index_total",
111+
"indexing.index_failed",
112+
"pri.indexing.index_failed",
113+
"indexing.index_failed_due_to_version_conflict",
114+
"pri.indexing.index_failed_due_to_version_conflict",
115+
"merges.current",
116+
"pri.merges.current",
117+
"merges.current_docs",
118+
"pri.merges.current_docs",
119+
"merges.current_size",
120+
"pri.merges.current_size",
121+
"merges.total",
122+
"pri.merges.total",
123+
"merges.total_docs",
124+
"pri.merges.total_docs",
125+
"merges.total_size",
126+
"pri.merges.total_size",
127+
"merges.total_time",
128+
"pri.merges.total_time",
129+
"refresh.total",
130+
"pri.refresh.total",
131+
"refresh.time",
132+
"pri.refresh.time",
133+
"refresh.external_total",
134+
"pri.refresh.external_total",
135+
"refresh.external_time",
136+
"pri.refresh.external_time",
137+
"refresh.listeners",
138+
"pri.refresh.listeners",
139+
"search.fetch_current",
140+
"pri.search.fetch_current",
141+
"search.fetch_time",
142+
"pri.search.fetch_time",
143+
"search.fetch_total",
144+
"pri.search.fetch_total",
145+
"search.open_contexts",
146+
"pri.search.open_contexts",
147+
"search.query_current",
148+
"pri.search.query_current",
149+
"search.query_time",
150+
"pri.search.query_time",
151+
"search.query_total",
152+
"pri.search.query_total",
153+
"search.scroll_current",
154+
"pri.search.scroll_current",
155+
"search.scroll_time",
156+
"pri.search.scroll_time",
157+
"search.scroll_total",
158+
"pri.search.scroll_total",
159+
"segments.count",
160+
"pri.segments.count",
161+
"segments.memory",
162+
"pri.segments.memory",
163+
"segments.index_writer_memory",
164+
"pri.segments.index_writer_memory",
165+
"segments.version_map_memory",
166+
"pri.segments.version_map_memory",
167+
"segments.fixed_bitset_memory",
168+
"pri.segments.fixed_bitset_memory",
169+
"warmer.current",
170+
"pri.warmer.current",
171+
"warmer.total",
172+
"pri.warmer.total",
173+
"warmer.total_time",
174+
"pri.warmer.total_time",
175+
"suggest.current",
176+
"pri.suggest.current",
177+
"suggest.time",
178+
"pri.suggest.time",
179+
"suggest.total",
180+
"pri.suggest.total",
181+
"memory.total",
182+
"pri.memory.total",
183+
"bulk.total_operations",
184+
"pri.bulk.total_operations",
185+
"bulk.total_time",
186+
"pri.bulk.total_time",
187+
"bulk.total_size_in_bytes",
188+
"pri.bulk.total_size_in_bytes",
189+
"bulk.avg_time",
190+
"pri.bulk.avg_time",
191+
"bulk.avg_size_in_bytes",
192+
"pri.bulk.avg_size_in_bytes",
193+
"dense_vector.value_count",
194+
"pri.dense_vector.value_count",
195+
"sparse_vector.value_count",
196+
"pri.sparse_vector.value_count"
197+
]
49198
},
50199
"health": {
51200
"type": "enum",
52-
"options": ["green", "yellow", "red"],
201+
"options": ["green", "yellow", "red", "unknown", "unavailable"],
53202
"description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"
54203
},
55204
"help": {
@@ -82,7 +231,7 @@
82231
"default": false
83232
},
84233
"expand_wildcards": {
85-
"type": "enum",
234+
"type": "list",
86235
"options": ["open", "closed", "hidden", "none", "all"],
87236
"default": "all",
88237
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."

‎specification/_json_spec/cat.master.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@
3535
},
3636
"h": {
3737
"type": "list",
38-
"description": "Comma-separated list of column names to display"
38+
"description": "Comma-separated list of column names to display",
39+
"options": ["id", "host", "ip", "node"]
3940
},
4041
"help": {
4142
"type": "boolean",

‎specification/_json_spec/cat.ml_data_frame_analytics.json‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,25 @@
4646
"h": {
4747
"type": "list",
4848
"default": "create_time,id,state,type",
49-
"description": "Comma-separated list of column names to display"
49+
"description": "Comma-separated list of column names to display",
50+
"options": [
51+
"assignment_explanation",
52+
"create_time",
53+
"description",
54+
"dest_index",
55+
"failure_reason",
56+
"id",
57+
"model_memory_limit",
58+
"node.address",
59+
"node.ephemeral_id",
60+
"node.id",
61+
"node.name",
62+
"progress",
63+
"source_index",
64+
"state",
65+
"type",
66+
"version"
67+
]
5068
},
5169
"help": {
5270
"type": "boolean",
@@ -55,7 +73,25 @@
5573
},
5674
"s": {
5775
"type": "list",
58-
"description": "Comma-separated list of column names or column aliases to sort by"
76+
"description": "Comma-separated list of column names or column aliases to sort by",
77+
"options": [
78+
"assignment_explanation",
79+
"create_time",
80+
"description",
81+
"dest_index",
82+
"failure_reason",
83+
"id",
84+
"model_memory_limit",
85+
"node.address",
86+
"node.ephemeral_id",
87+
"node.id",
88+
"node.name",
89+
"progress",
90+
"source_index",
91+
"state",
92+
"type",
93+
"version"
94+
]
5995
},
6096
"time": {
6197
"type": "enum",

0 commit comments

Comments
 (0)