You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/overlays/elasticsearch-shared-overlays.yaml
+62-4Lines changed: 62 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,15 @@ actions:
12
12
# A
13
13
- name: autoscaling
14
14
x-displayName: Autoscaling
15
+
description: >
16
+
The autoscaling APIs enable you to create and manage autoscaling policies and retrieve information about autoscaling capacity.
17
+
Autoscaling adjusts resources based on demand. A deployment can use autoscaling to scale resources as needed, ensuring sufficient capacity to meet workload requirements.
15
18
# B
16
19
- name: analytics
17
20
x-displayName: Behavioral analytics
21
+
description: >
22
+
The behavioral analytics APIs let you create and manage analytics collections and view their data.
23
+
Use them to analyze users’ search and click behavior, improve result relevance, and identify content gaps.
18
24
# C
19
25
- name: cat
20
26
x-displayName: Compact and aligned text (CAT)
@@ -26,8 +32,13 @@ actions:
26
32
All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands.
27
33
- name: cluster
28
34
x-displayName: Cluster
35
+
description: >
36
+
The cluster APIs enable you to retrieve information about your infrastructure on cluster, node, or shard level.
37
+
You can manage cluster settings and voting configuration exceptions, collect node statistics and retrieve node information.
29
38
- name: health_report
30
39
x-displayName: Cluster - Health
40
+
description: >
41
+
The cluster - health API provides you a report with the health status of an Elasticsearch cluster.
31
42
- name: connector
32
43
x-displayName: Connector
33
44
description: >
@@ -43,20 +54,32 @@ actions:
43
54
description: Check out the connector API tutorial.
44
55
- name: ccr
45
56
x-displayName: Cross-cluster replication
57
+
description: >
58
+
The cross-cluster replication (CCR) APIs let you run replication operations, such as creating and managing follower indices or auto-follow patterns.
59
+
Use CCR to replicate indices across clusters to maintain search availability during outages, reduce indexing impact, and lower search latency by serving requests closer to users.
46
60
# D
47
61
- name: data stream
48
62
x-displayName: Data stream
63
+
description: >
64
+
The data stream APIs enable you to create and manage data streams and data stream lifecycles.
65
+
A data stream lets you store append-only time series data across multiple indices while giving you a single named resource for requests.
66
+
Data streams are well-suited for logs, events, metrics, and other continuously generated data.
description: Learn more about managing the index lifecycle.
@@ -103,6 +131,8 @@ actions:
103
131
However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
104
132
- name: info
105
133
x-displayName: Info
134
+
description: >
135
+
The info API provides basic build, version, and cluster information.
106
136
- name: ingest
107
137
x-displayName: Ingest
108
138
description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors.
@@ -123,31 +153,40 @@ actions:
123
153
# M
124
154
- name: ml
125
155
x-displayName: Machine learning
156
+
description: >
157
+
The machine learning APIs enable you to retrieve information related to the Elastic Stack machine learning features.
126
158
- name: ml anomaly
127
159
x-displayName: Machine learning anomaly detection
128
-
# description:
160
+
description: >
161
+
The machine learning anomaly detection APIs enbale you to perform anomaly detection activities.
description: Learn more about natural language processing.
144
179
- name: migration
145
180
x-displayName: Migration
181
+
description: >
182
+
The migration APIs power Kibana's Upgrade Assistant feature.
146
183
- name: monitoring
147
184
x-displayName: Monitoring
148
185
# N
149
186
- name: shutdown
150
187
x-displayName: Node lifecycle
188
+
description: >
189
+
The node lifecycle APIs enable you to prepare nodes for temporary or permanent shutdown, monitor the shutdown status, and enable a previously shut-down node to resume normal operations.
151
190
# Q
152
191
- name: query_rules
153
192
x-displayName: Query rules
@@ -164,6 +203,8 @@ actions:
164
203
# R
165
204
- name: rollup
166
205
x-displayName: Rollup
206
+
description: >
207
+
The rollup APIs enable you to create, manage, and retrieve infromation about rollup jobs.
0 commit comments