Skip to content

Commit 98be5c3

Browse files
[DOCS]: Add descriptions to API tags (#5098)
* add descriptions Co-authored-by: István Zoltán Szabó <[email protected]>
1 parent c26dfd2 commit 98be5c3

File tree

1 file changed

+62
-4
lines changed

1 file changed

+62
-4
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,15 @@ actions:
1212
# A
1313
- name: autoscaling
1414
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.
1518
# B
1619
- name: analytics
1720
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.
1824
# C
1925
- name: cat
2026
x-displayName: Compact and aligned text (CAT)
@@ -26,8 +32,13 @@ actions:
2632
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.
2733
- name: cluster
2834
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.
2938
- name: health_report
3039
x-displayName: Cluster - Health
40+
description: >
41+
The cluster - health API provides you a report with the health status of an Elasticsearch cluster.
3142
- name: connector
3243
x-displayName: Connector
3344
description: >
@@ -43,20 +54,32 @@ actions:
4354
description: Check out the connector API tutorial.
4455
- name: ccr
4556
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.
4660
# D
4761
- name: data stream
4862
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.
4967
externalDocs:
5068
description: Learn more about data streams.
5169
url: https://www.elastic.co/docs/manage-data/data-store/data-streams
5270
- name: document
5371
x-displayName: Document
72+
description: >
73+
The document APIs enable you to create and manage documents in an Elasticsearch index.
5474
externalDocs:
5575
description: Learn more about reading and writing documents.
5676
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/reading-and-writing-documents
5777
# E
5878
- name: enrich
5979
x-displayName: Enrich
80+
description: >
81+
The enrich APIs enable you to manage enrich policies.
82+
An enrich policy is a set of configuration options used to add the right enrich data to the right incoming documents.
6083
- name: eql
6184
x-displayName: EQL
6285
description: >
@@ -73,10 +96,13 @@ actions:
7396
description: Learn more about ES|QL.
7497
# F
7598
- name: features
76-
description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
7799
x-displayName: Features
100+
description: >
101+
The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
78102
- name: fleet
79103
x-displayName: Fleet
104+
description: >
105+
The Fleet APIs support Fleet’s use of Elasticsearch as a data store for internal agent and action data.
80106
# G
81107
- name: graph
82108
x-displayName: Graph explore
@@ -92,6 +118,8 @@ actions:
92118
Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
93119
- name: ilm
94120
x-displayName: Index lifecycle management
121+
description: >
122+
The index lifecycle management APIs enable you to set up policies to automatically manage the index lifecycle.
95123
externalDocs:
96124
url: https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management
97125
description: Learn more about managing the index lifecycle.
@@ -103,6 +131,8 @@ actions:
103131
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.
104132
- name: info
105133
x-displayName: Info
134+
description: >
135+
The info API provides basic build, version, and cluster information.
106136
- name: ingest
107137
x-displayName: Ingest
108138
description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors.
@@ -123,31 +153,40 @@ actions:
123153
# M
124154
- name: ml
125155
x-displayName: Machine learning
156+
description: >
157+
The machine learning APIs enable you to retrieve information related to the Elastic Stack machine learning features.
126158
- name: ml anomaly
127159
x-displayName: Machine learning anomaly detection
128-
# description:
160+
description: >
161+
The machine learning anomaly detection APIs enbale you to perform anomaly detection activities.
129162
externalDocs:
130163
url: https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-finding-anomalies
131164
description: Learn more about finding anomalies.
132165
- name: ml data frame
133166
x-displayName: Machine learning data frame analytics
134-
# description:
167+
description: >
168+
The machine learning data frame analytics APIs enbale you to perform data frame analytics activities.
135169
externalDocs:
136170
url: https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-overview
137171
description: Learn more about data frame analytics.
138172
- name: ml trained model
139173
x-displayName: Machine learning trained model
140-
# description:
174+
description: >
175+
The machine learning trained models APIs enable you to perform model management operations.
141176
externalDocs:
142177
url: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-overview
143178
description: Learn more about natural language processing.
144179
- name: migration
145180
x-displayName: Migration
181+
description: >
182+
The migration APIs power Kibana's Upgrade Assistant feature.
146183
- name: monitoring
147184
x-displayName: Monitoring
148185
# N
149186
- name: shutdown
150187
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.
151190
# Q
152191
- name: query_rules
153192
x-displayName: Query rules
@@ -164,6 +203,8 @@ actions:
164203
# R
165204
- name: rollup
166205
x-displayName: Rollup
206+
description: >
207+
The rollup APIs enable you to create, manage, and retrieve infromation about rollup jobs.
167208
# S
168209
- name: script
169210
x-displayName: Script
@@ -174,12 +215,21 @@ actions:
174215
url: https://www.elastic.co/docs/explore-analyze/scripting
175216
- name: search
176217
x-displayName: Search
218+
description: >
219+
The search APIs enable you to search and aggregate data stored in Elasticsearch indices and data streams.
177220
- name: search_application
178221
x-displayName: Search application
222+
description: >
223+
The search applcation APIs enable you to manage tasks and resources related to Search Applications.
179224
- name: searchable_snapshots
180225
x-displayName: Searchable snapshots
226+
description: >
227+
The searchable snapshots APIs enable you to perform searchable snapshots operations.
181228
- name: security
182229
x-displayName: Security
230+
description: >
231+
The security APIs enable you to perform security activities, and add, update, retrieve, and remove application privileges, role mappings, and roles.
232+
You can also create and update API keys and create and invalidate bearer tokens.
183233
- name: snapshot
184234
x-displayName: Snapshot and restore
185235
description: >
@@ -210,13 +260,21 @@ actions:
210260
# T
211261
- name: tasks
212262
x-displayName: Task management
263+
description: >
264+
The task management APIs enable you to retrieve information about tasks or cancel tasks running in a cluster.
213265
- name: text_structure
214266
x-displayName: Text structure
267+
description: >
268+
The text structure APIs enable you to find the structure of a text field in an Elasticsearch index.
215269
- name: transform
216270
x-displayName: Transform
271+
description: >
272+
The transform APIs enable you to create and manage transforms.
217273
# U
218274
- name: xpack
219275
x-displayName: Usage
276+
description: >
277+
The usage API provides usage information about the installed X-Pack features.
220278
# W
221279
- name: watcher
222280
x-displayName: Watcher

0 commit comments

Comments
 (0)