Skip to content

Commit

Permalink
[8.x] [OpenAPI][DOCS] Edit role and space tags (#194888) (#195317)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI][DOCS] Edit role and space tags
(#194888)](#194888)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-07T20:09:08Z","message":"[OpenAPI][DOCS]
Edit role and space tags
(#194888)","sha":"e923dca1f4086baff2043791b925c3c2bb8d0bc8","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Security/Spaces","release_note:skip","v9.0.0","docs","v8.16.0","backport:version"],"title":"[OpenAPI][DOCS]
Edit role and space
tags","number":194888,"url":"https://github.com/elastic/kibana/pull/194888","mergeCommit":{"message":"[OpenAPI][DOCS]
Edit role and space tags
(#194888)","sha":"e923dca1f4086baff2043791b925c3c2bb8d0bc8"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194888","number":194888,"mergeCommit":{"message":"[OpenAPI][DOCS]
Edit role and space tags
(#194888)","sha":"e923dca1f4086baff2043791b925c3c2bb8d0bc8"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
kibanamachine and lcawl authored Oct 7, 2024
1 parent 46fd6db commit c28764d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
5 changes: 5 additions & 0 deletions oas_docs/overlays/kibana.overlays.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ actions:
description: Change displayName
update:
x-displayName: "Service level objectives"
- target: '$.tags[?(@.name=="spaces")]'
description: Change displayName
update:
x-displayName: "Spaces"
description: Manage your Kibana spaces.
- target: '$.tags[?(@.name=="system")]'
description: Change displayName and description
update:
Expand Down
22 changes: 19 additions & 3 deletions oas_docs/overlays/kibana.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,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/current/xpack-spaces.html).
To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html).
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="alerting")]'
description: Change tag description and displayName
Expand All @@ -34,7 +34,7 @@ actions:
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
externalDocs:
description: Alerting documentation
url: https://www.elastic.co/guide/en/kibana/current/alerting-getting-started.html
url: https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html
x-displayName: "Alerting"
- target: '$.tags[?(@.name=="cases")]'
description: Change tag description and displayName
Expand All @@ -45,7 +45,7 @@ actions:
You can also send cases to external incident management systems by configuring connectors.
externalDocs:
description: Cases documentation
url: https://www.elastic.co/guide/en/kibana/current/cases.html
url: https://www.elastic.co/guide/en/kibana/master/cases.html
x-displayName: "Cases"
- target: '$.tags[?(@.name=="connectors")]'
description: Change tag description and displayName
Expand All @@ -65,10 +65,26 @@ actions:
description: Change displayName
update:
x-displayName: "Machine learning"
- target: '$.tags[?(@.name=="roles")]'
description: Change displayName and description
update:
x-displayName: "Roles"
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
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:
x-displayName: "Service level objectives"
- target: '$.tags[?(@.name=="spaces")]'
description: Change displayName
update:
x-displayName: "Spaces"
description: Manage your Kibana spaces.
externalDocs:
url: https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html
description: Space overview
- target: '$.tags[?(@.name=="system")]'
description: Change displayName and description
update:
Expand Down

0 comments on commit c28764d

Please sign in to comment.