Skip to content

Commit ae8d7bf

Browse files
lcawlgeorgewallaceflorent-leborgnenatasha-moore-elastickibanamachine
authored
[9.0] adding missing descriptions for tags (#237011) (#237943)
# Backport This will backport the following commits from `main` to `9.0`: - [adding missing descriptions for tags (#237011)](#237011) <!--- Backport version: 10.0.2 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"George Wallace","email":"georgewallace@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-10-07T17:01:35Z","message":"adding missing descriptions for tags (#237011)\n\n## Summary\n\nAdding descriptions in overlays for tags that were missing descriptions.\nWe are going to be moving to a single page experience for our API docs\nand this means that each tag will have it's own page. In the current\nform of the OpenAPI Spec if there is no description we will have a\ncompletely blank page which is a bad experience.\n\nPlease review the `Description > ` text as that is what will be showing\nin the API docs.\n<img width=\"1165\" height=\"913\" alt=\"Screenshot 2025-09-30 at 10 57\n40 AM\"\nsrc=\"https://github.com/user-attachments/assets/45a60239-90d6-4c82-81b4-da851245d93c\"\n/>\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: lcawl <lcawley@elastic.co>\nCo-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>","sha":"63d16dd3a104fb6ff72056d780253ad8e3945abe","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport:skip","docs","APIDocs","v9.3.0"],"title":"adding missing descriptions for tags","number":237011,"url":"https://github.com/elastic/kibana/pull/237011","mergeCommit":{"message":"adding missing descriptions for tags (#237011)\n\n## Summary\n\nAdding descriptions in overlays for tags that were missing descriptions.\nWe are going to be moving to a single page experience for our API docs\nand this means that each tag will have it's own page. In the current\nform of the OpenAPI Spec if there is no description we will have a\ncompletely blank page which is a bad experience.\n\nPlease review the `Description > ` text as that is what will be showing\nin the API docs.\n<img width=\"1165\" height=\"913\" alt=\"Screenshot 2025-09-30 at 10 57\n40 AM\"\nsrc=\"https://github.com/user-attachments/assets/45a60239-90d6-4c82-81b4-da851245d93c\"\n/>\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: lcawl <lcawley@elastic.co>\nCo-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>","sha":"63d16dd3a104fb6ff72056d780253ad8e3945abe"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/237011","number":237011,"mergeCommit":{"message":"adding missing descriptions for tags (#237011)\n\n## Summary\n\nAdding descriptions in overlays for tags that were missing descriptions.\nWe are going to be moving to a single page experience for our API docs\nand this means that each tag will have it's own page. In the current\nform of the OpenAPI Spec if there is no description we will have a\ncompletely blank page which is a bad experience.\n\nPlease review the `Description > ` text as that is what will be showing\nin the API docs.\n<img width=\"1165\" height=\"913\" alt=\"Screenshot 2025-09-30 at 10 57\n40 AM\"\nsrc=\"https://github.com/user-attachments/assets/45a60239-90d6-4c82-81b4-da851245d93c\"\n/>\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: lcawl <lcawley@elastic.co>\nCo-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>","sha":"63d16dd3a104fb6ff72056d780253ad8e3945abe"}}]}] BACKPORT--> Co-authored-by: George Wallace <georgewallace@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
1 parent d1b29ed commit ae8d7bf

9 files changed

Lines changed: 297 additions & 58 deletions

File tree

‎oas_docs/output/kibana.serverless.yaml‎

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,25 +75,62 @@ tags:
7575
x-displayName: Connectors
7676
- name: Dashboards
7777
- name: Data streams
78+
description: |
79+
Data stream APIs enable you to manage data streams, which are collections of indices that share the same index template and are managed as a single unit for time-series data.
80+
x-displayName: Data streams
7881
- description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
7982
name: data views
8083
x-displayName: Data views
8184
- name: Elastic Agent actions
85+
description: |
86+
Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bulk operations for agent lifecycle management.
87+
x-displayName: Elastic Agent actions
8288
- name: Elastic Agent binary download sources
89+
description: |
90+
Elastic Agent binary download sources APIs enable you to manage download sources for Elastic Agent binaries, including creating, updating, and deleting custom download sources for agent binaries.
91+
x-displayName: Elastic Agent binary download sources
8392
- name: Elastic Agent policies
93+
description: |
94+
Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and auto-upgrade status information.
95+
x-displayName: Elastic Agent policies
8496
- name: Elastic Agent status
97+
description: |
98+
Enables you to retrieve status information about Elastic Agents, including health summaries and operational status.
99+
x-displayName: Elastic Agent status
85100
- name: Elastic Agents
101+
description: |
102+
Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.
103+
x-displayName: Elastic Agents
86104
- name: Elastic Package Manager (EPM)
87105
- name: Fleet enrollment API keys
106+
description: |
107+
Fleet enrollment API keys APIs enable you to manage enrollment API keys for Fleet, including creating, retrieving, and revoking API keys used for agent enrollment.
108+
x-displayName: Fleet enrollment API keys
88109
- name: Fleet internals
110+
description: |
111+
Fleet internals APIs enable you to manage Fleet internal operations, including checking permissions, monitoring Fleet Server health, managing settings, and initiating Fleet setup.
112+
x-displayName: Fleet internals
89113
- name: Fleet outputs
114+
description: |
115+
Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.
116+
x-displayName: Fleet outputs
90117
- name: Fleet package policies
118+
description: |
119+
Fleet package policies APIs enable you to manage Fleet package policies, including creating, updating, and deleting policies, performing bulk operations, and managing policy upgrades.
120+
x-displayName: Fleet package policies
91121
- name: Fleet proxies
122+
description: |
123+
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
124+
x-displayName: Fleet proxies
92125
- name: Fleet Server hosts
93126
- name: Fleet service tokens
94127
- name: Fleet uninstall tokens
95128
- name: Message Signing Service
96-
- description: Machine learning
129+
description: |
130+
Enables you to rotate message signing key pairs for secure Fleet communication.
131+
x-displayName: Fleet Message Signing Service
132+
- description: |
133+
Enables you to synchronize machine learning saved objects.
97134
name: ml
98135
x-displayName: Machine learning
99136
- name: roles
@@ -142,7 +179,8 @@ tags:
142179
- description: Interact with and manage endpoints running the Elastic Defend integration.
143180
name: Security Endpoint Management API
144181
x-displayName: Security endpoint management
145-
- description: ''
182+
- description: |
183+
Use the Security entity analytics APIs to manage entity analytics and risk scoring, including asset criticality, privileged user monitoring, and entity engines.
146184
name: Security Entity Analytics API
147185
x-displayName: Security entity analytics
148186
- description: |
@@ -220,15 +258,19 @@ tags:
220258
- name: spaces
221259
x-displayName: Spaces
222260
description: Manage your Kibana spaces.
261+
externalDocs:
262+
url: https://www.elastic.co/docs/deploy-manage/manage-spaces
263+
description: Space overview
223264
- name: streams
224265
description: |
225266
Streams is a new and experimental way to manage your data in Kibana. The API is currently not considered stable and can change at any point.
226267
x-displayName: Streams
227268
- name: system
228269
x-displayName: System
229270
description: |
230-
Get information about the system status, resource usage, and installed plugins.
231-
- externalDocs:
271+
Get information about the system status, resource usage, features, and installed plugins.
272+
- description: Task manager APIs enable you to check the health of the Kibana task manager, which is used by features such as alerting, actions, and reporting to run mission critical work as persistent background tasks.
273+
externalDocs:
232274
description: Task manager
233275
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
234276
name: task manager

‎oas_docs/output/kibana.yaml‎

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,23 +89,68 @@ tags:
8989
x-displayName: Connectors
9090
- name: Dashboards
9191
- name: Data streams
92+
description: |
93+
Data stream APIs enable you to manage data streams, which are collections of indices that share the same index template and are managed as a single unit for time-series data.
94+
x-displayName: Data streams
9295
- description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
9396
name: data views
9497
x-displayName: Data views
9598
- name: Elastic Agent actions
99+
description: |
100+
Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bulk operations for agent lifecycle management.
101+
x-displayName: Elastic Agent actions
96102
- name: Elastic Agent binary download sources
103+
description: |
104+
Elastic Agent binary download sources APIs enable you to manage download sources for Elastic Agent binaries, including creating, updating, and deleting custom download sources for agent binaries.
105+
x-displayName: Elastic Agent binary download sources
97106
- name: Elastic Agent policies
107+
description: |
108+
Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and auto-upgrade status information.
109+
x-displayName: Elastic Agent policies
98110
- name: Elastic Agent status
111+
description: |
112+
Enables you to retrieve status information about Elastic Agents, including health summaries and operational status.
113+
x-displayName: Elastic Agent status
99114
- name: Elastic Agents
115+
description: |
116+
Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.
117+
x-displayName: Elastic Agents
100118
- name: Elastic Package Manager (EPM)
119+
description: |
120+
Elastic Package Manager (EPM) APIs enable you to manage packages and integrations, including installing, updating, and uninstalling packages, managing custom integrations, and handling package assets.
121+
x-displayName: Elastic Package Manager (EPM)
101122
- name: Fleet enrollment API keys
123+
description: |
124+
Fleet enrollment API keys APIs enable you to manage enrollment API keys for Fleet, including creating, retrieving, and revoking API keys used for agent enrollment.
125+
x-displayName: Fleet enrollment API keys
102126
- name: Fleet internals
127+
description: |
128+
Fleet internals APIs enable you to manage Fleet internal operations, including checking permissions, monitoring Fleet Server health, managing settings, and initiating Fleet setup.
129+
x-displayName: Fleet internals
103130
- name: Fleet outputs
131+
description: |
132+
Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.
133+
x-displayName: Fleet outputs
104134
- name: Fleet package policies
135+
description: |
136+
Fleet package policies APIs enable you to manage Fleet package policies, including creating, updating, and deleting policies, performing bulk operations, and managing policy upgrades.
137+
x-displayName: Fleet package policies
105138
- name: Fleet proxies
139+
description: |
140+
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
141+
x-displayName: Fleet proxies
106142
- name: Fleet Server hosts
143+
description: |
144+
Fleet Server hosts APIs enable you to manage Fleet Server hosts, including creating, updating, and deleting Fleet Server host configurations.
145+
x-displayName: Fleet Server hosts
107146
- name: Fleet service tokens
147+
description: |
148+
Enables you to create tokens for Fleet service authentication and authorization.
149+
x-displayName: Fleet service tokens
108150
- name: Fleet uninstall tokens
151+
description: |
152+
Fleet uninstall tokens APIs enable you to manage Fleet uninstall tokens, including retrieving metadata and decrypted tokens for agent uninstallation.
153+
x-displayName: Fleet uninstall tokens
109154
- description: |
110155
Programmatically integrate with Logstash configuration management.
111156
> warn
@@ -116,7 +161,11 @@ tags:
116161
name: logstash
117162
x-displayName: Logstash configuration management
118163
- name: Message Signing Service
119-
- description: Machine learning
164+
description: |
165+
Enables you to rotate message signing key pairs for secure Fleet communication.
166+
x-displayName: Fleet Message Signing Service
167+
- description: |
168+
Enables you to synchronize machine learning saved objects.
120169
name: ml
121170
x-displayName: Machine learning
122171
- name: roles
@@ -135,7 +184,7 @@ tags:
135184
* [Spaces](../group/endpoint-spaces)
136185
* [Short URLs](../group/endpoint-short-url)
137186

138-
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions
187+
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
139188
name: saved objects
140189
x-displayName: Saved objects
141190
- description: Manage and interact with Security Assistant resources.
@@ -165,7 +214,8 @@ tags:
165214
- description: Interact with and manage endpoints running the Elastic Defend integration.
166215
name: Security Endpoint Management API
167216
x-displayName: Security endpoint management
168-
- description: ''
217+
- description: |
218+
Use the Security entity analytics APIs to manage entity analytics and risk scoring, including asset criticality, privileged user monitoring, and entity engines.
169219
name: Security Entity Analytics API
170220
x-displayName: Security entity analytics
171221
- description: |
@@ -251,6 +301,7 @@ tags:
251301
description: Space overview
252302
- name: synthetics
253303
x-displayName: Synthetics
304+
description: Synthetics APIs enable you to check the status of your services and applications.
254305
externalDocs:
255306
description: Synthetic monitoring
256307
url: https://www.elastic.co/docs/solutions/observability/synthetics
@@ -262,21 +313,25 @@ tags:
262313
Get information about the system status, resource usage, features, and installed plugins.
263314
name: system
264315
x-displayName: System
265-
- externalDocs:
316+
- description: Task manager APIs enable you to check the health of the Kibana task manager, which is used by features such as alerting, actions, and reporting to run mission critical work as persistent background tasks.
317+
externalDocs:
266318
description: Task manager
267319
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
268320
name: task manager
269321
x-displayName: Task manager
270322
- description: The assistant helps you prepare for the next major version of Elasticsearch.
271323
name: upgrade
272324
x-displayName: Upgrade assistant
273-
- externalDocs:
325+
- description: Uptime APIs enable you to view and update uptime monitoring settings.
326+
externalDocs:
274327
description: Uptime monitoring
275328
url: https://www.elastic.co/docs/solutions/observability/uptime
276329
name: uptime
277330
x-displayName: Uptime
278331
- name: user session
279332
x-displayName: User session management
333+
description: |
334+
Enables you to invalidate user sessions for security and session management purposes.
280335
paths:
281336
/api/actions/connector_types:
282337
get:

0 commit comments

Comments
 (0)