github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Fix URLs in Kibana API documentation (#215989)

Browse source
This commit is contained in:
Lisa Cawley 2025-05-06 16:01:09 -07:00 • committed by GitHub
parent 2a2b10e15a
commit 9635e5f28b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
oas_docs/kibana.info.yaml
View file

@ -23,7 +23,7 @@ info:
GET kbn:/api/data_views
```
For more information about the console, refer to [Run API requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
For more information about the console, refer to [Run API requests](https://www.elastic.co/docs/explore-analyze/query-filter/tools/console).
NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.

2
oas_docs/output/kibana.serverless.yaml
View file

@ -102,7 +102,7 @@ tags:
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
url: https://www.elastic.co/docs/deploy-manage/users-roles/serverless-custom-roles
- name: saved objects
x-displayName: Saved objects
description: |

14
oas_docs/output/kibana.yaml
View file

@ -24,7 +24,7 @@ info:
GET kbn:/api/data_views
```
For more information about the console, refer to [Run API requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
For more information about the console, refer to [Run API requests](https://www.elastic.co/docs/explore-analyze/query-filter/tools/console).
NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.
@ -125,7 +125,7 @@ tags:
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
url: https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles
- name: saved objects
x-displayName: Saved objects
description: |
@ -135,8 +135,8 @@ tags:
For example, use:
* [Data views](../group/endpoint-data-views)
* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
* [Spaces](../group/endpoint-spaces)
* [Short URLs](../group/endpoint-short-url)
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
- description: Manage and interact with Security Assistant resources.
@ -248,7 +248,7 @@ tags:
x-displayName: Spaces
description: Manage your Kibana spaces.
externalDocs:
url: https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html
url: https://www.elastic.co/docs/deploy-manage/manage-spaces
description: Space overview
- name: streams
description: |
@ -258,7 +258,7 @@ tags:
x-displayName: Synthetics
externalDocs:
description: Synthetic monitoring
url: https://www.elastic.co/guide/en/observability/current/monitor-uptime-synthetics.html
url: https://www.elastic.co/docs/solutions/observability/synthetics
- name: system
x-displayName: System
description: |
@ -82118,4 +82118,4 @@ x-topics:
If you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.
To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
To learn more, check out [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces).

2
oas_docs/overlays/kibana.overlays.serverless.yaml
View file

@ -37,7 +37,7 @@ actions:
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
url: https://www.elastic.co/docs/deploy-manage/users-roles/serverless-custom-roles
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:

12
oas_docs/overlays/kibana.overlays.yaml
View file

@ -34,7 +34,7 @@ actions:
If you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.
To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
To learn more, check out [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces).
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="streams")]'
description: Change tag description and displayName
@ -57,7 +57,7 @@ actions:
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
url: https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:
@ -68,7 +68,7 @@ actions:
x-displayName: "Spaces"
description: Manage your Kibana spaces.
externalDocs:
url: https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html
url: https://www.elastic.co/docs/deploy-manage/manage-spaces
description: Space overview
- target: '$.tags[?(@.name=="system")]'
description: Change displayName and description
@ -91,8 +91,8 @@ actions:
For example, use:
* [Data views](../group/endpoint-data-views)
* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
* [Spaces](../group/endpoint-spaces)
* [Short URLs](../group/endpoint-short-url)
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
- target: '$.tags[?(@.name=="synthetics")]'
@ -101,7 +101,7 @@ actions:
x-displayName: Synthetics
externalDocs:
description: Synthetic monitoring
url: https://www.elastic.co/guide/en/observability/current/monitor-uptime-synthetics.html
url: https://www.elastic.co/docs/solutions/observability/synthetics
# Remove extra tags from operations
- target: "$.paths[*][*].tags[1:]"
description: Remove all but first tag from operations