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

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

Browse source 
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Fix URLs in Kibana API documentation
(#215989)](https://github.com/elastic/kibana/pull/215989)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-05-06T23:01:09Z","message":"[DOCS]
Fix URLs in Kibana API documentation
(#215989)","sha":"9635e5f28bf2950c06a4e093e5b873e4e501a65f","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.1.0","v9.0.1"],"title":"[DOCS]
Fix URLs in Kibana API
documentation","number":215989,"url":"https://github.com/elastic/kibana/pull/215989","mergeCommit":{"message":"[DOCS]
Fix URLs in Kibana API documentation
(#215989)","sha":"9635e5f28bf2950c06a4e093e5b873e4e501a65f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/215989","number":215989,"mergeCommit":{"message":"[DOCS]
Fix URLs in Kibana API documentation
(#215989)","sha":"9635e5f28bf2950c06a4e093e5b873e4e501a65f"}},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
This commit is contained in:
Lisa Cawley 2025-05-09 08:41:39 -07:00 • committed by GitHub
parent 1c7514386e
commit 6e63800177
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 22 additions and 14 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.

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

@ -101,9 +101,17 @@ tags:
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
<<<<<<< HEAD
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
- description: |
Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
=======
url: https://www.elastic.co/docs/deploy-manage/users-roles/serverless-custom-roles
- name: saved objects
x-displayName: Saved objects
description: |
Export or import sets of saved objects.
>>>>>>> 128b8457a61 ([DOCS] Fix URLs in Kibana API documentation (#215989))
To manage a specific type of saved object, use the corresponding APIs.
For example, use:

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.
@ -124,7 +124,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
- description: |
Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
@ -132,8 +132,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
name: saved objects
@ -247,13 +247,13 @@ 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: synthetics
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: |
@ -72541,4 +72541,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).

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