Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OpenAPI][DOCS] Edit role and space tags #194888

Merged
merged 6 commits into from
Oct 7, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 4, 2024

Summary

Relates to #192153

This PR edits the tags for the space and role management APIs in the OpenAPI documents. In particular, it adds x-displayName values to align with the capitalization of other tags and it adds some descriptions and external links.
It also edits a couple of other URLs that were targeting "current" instead of "master".

@lcawl lcawl added Feature:Security/Spaces Platform Security - Spaces feature release_note:skip Skip the PR/issue when compiling release notes docs v8.16.0 backport:version Backport to applied version labels labels Oct 4, 2024
@lcawl lcawl requested review from jeramysoucy and a team October 4, 2024 00:14
@lcawl lcawl marked this pull request as ready for review October 4, 2024 00:14
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl enabled auto-merge (squash) October 7, 2024 16:18
@lcawl lcawl merged commit e923dca into elastic:main Oct 7, 2024
24 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11223163894

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@lcawl lcawl deleted the api-security-tags branch October 7, 2024 20:12
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 7, 2024
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Oct 7, 2024
# 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":"lcawley@elastic.co"},"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 <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs Feature:Security/Spaces Platform Security - Spaces feature release_note:skip Skip the PR/issue when compiling release notes v8.16.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants