Skip to content

[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs#195527

Merged
lcawl merged 11 commits intoelastic:mainfrom
lcawl:role-apis
Oct 25, 2024
Merged

[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs#195527
lcawl merged 11 commits intoelastic:mainfrom
lcawl:role-apis

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Oct 9, 2024 •
edited by kibanamachine
Loading

Summary

Relates to #192153

This PR adds descriptions and responses for role APIs, derived from the content in https://www.elastic.co/guide/en/kibana/current/role-management-api.html
Since per #188926 examples aren't integrated into the automated documents yet, I've added them via overlays.

It also removes the old API docs, updates links to those pages, and creates temporary redirects until links can be cleaned out of the entire library.

@azasypkin Related to #186800 I've added a description for replaceDeprecatedPrivileges but if it's not accurate lmk!

@lcawl lcawl added Team:Security Platform Security: Auth, Users, Roles, Spaces, Audit Logging, etc t// release_note:skip Skip the PR/issue when compiling release notes Feature:Security/Authorization Platform Security - Authorization docs v8.16.0 backport:version Backport to applied version labels labels Oct 9, 2024
@lcawl lcawl changed the title [OpenAPI][DOCS] Add descriptions and responses for role APIs [OpenAPI][DOCS] Add descriptions, examples, responses for role APIs Oct 16, 2024
@lcawl lcawl marked this pull request as ready for review October 16, 2024 00:21
@lcawl lcawl requested a review from a team as a code owner October 16, 2024 00:21
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 16, 2024

Pinging @elastic/kibana-security (Team:Security)

@elena-shostak elena-shostak self-requested a review October 16, 2024 10:14
elena-shostak
elena-shostak reviewed Oct 16, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@elena-shostak elena-shostak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me!

Let's wait for the second review from the team!

Comment thread oas_docs/examples/create_role_request1.yaml Outdated
Comment thread oas_docs/examples/create_role_request2.yaml Outdated
Comment thread oas_docs/examples/create_role_request3.yaml Outdated
Comment thread oas_docs/examples/create_role_request4.yaml Outdated
@lcawl lcawl requested a review from a team as a code owner October 16, 2024 19:49
lcawl and others added 8 commits October 24, 2024 09:20
@lcawl
[OpenAPI][DOCS] Add descriptions and responses for role APIs
a706f90
@lcawl
Regenerate output
d05fdf3
@lcawl
[DOCS] Add example overlays
370a2ba
@lcawl @elena-shostak
Update oas_docs/examples/create_role_request1.yaml
a77170f 
Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
@lcawl @elena-shostak
Update oas_docs/examples/create_role_request2.yaml
c4fe2db 
Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
@lcawl @elena-shostak
Update oas_docs/examples/create_role_request4.yaml
e3074aa 
Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
@lcawl @elena-shostak
Update oas_docs/examples/create_role_request3.yaml
29bb1de 
Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
@lcawl
[DOCS] Retire API pages
723e7a1
tsullivan
tsullivan approved these changes Oct 24, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SharedUX changes LGTM

@kibanamachine
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
5dd2d13 
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
@kibanamachine
[CI] Auto-commit changed files from 'make api-docs'
816b354
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 24, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

  • 💚 Build #244063 succeeded ac5ca54b8c4b46238bc9b9590f5f1f58f3a9f8e3
  • 💛 Build #243278 was flaky e5de9d87834317bb1634abc09774149e1e3f6e49
  • 💚 Build #242919 succeeded bbfe3f93d4aeda728dc74d00dc917bc25e45b6a5

@lcawl lcawl added the v8.17.0 label Oct 25, 2024
@lcawl lcawl merged commit 02fab72 into elastic:main Oct 25, 2024
@lcawl lcawl deleted the role-apis branch October 25, 2024 17:14
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 25, 2024

Starting backport for target branches: 8.16, 8.x

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

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 25, 2024

💔 All backports failed

Status Branch Result
❌ 8.16 Backport failed because of merge conflicts
❌ 8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 195527

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl mentioned this pull request Oct 25, 2024
Merged
@lcawl lcawl mentioned this pull request Oct 25, 2024
Merged
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Oct 25, 2024

💚 All backports created successfully

Status Branch Result
✅ 8.x
✅ 8.16

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Oct 25, 2024
@lcawl @elena-shostak
[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs (e…
cf7dbad 
…lastic#195527)

Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
(cherry picked from commit 02fab72)
lcawl added a commit that referenced this pull request Oct 28, 2024
@lcawl @kibanamachine
[8.16] [OpenAPI][DOCS] Add descriptions, examples, responses for role…
f5e7c9b 
… APIs (#195527) (#197890)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs
(#195527)](#195527)

<!--- Backport version: 8.9.8 -->

### 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-25T17:13:57Z","message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","Feature:Security/Authorization","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"number":195527,"url":"https://github.com/elastic/kibana/pull/195527","mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195527","number":195527,"mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 28, 2024
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 28, 2024

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

lcawl added a commit to lcawl/kibana that referenced this pull request Oct 28, 2024
@lcawl @elena-shostak
[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs (e…
0cb14b5 
…lastic#195527)

Co-authored-by: Elena Shostak <165678770+elena-shostak@users.noreply.github.com>
(cherry picked from commit 02fab72)
lcawl added a commit that referenced this pull request Oct 29, 2024
@lcawl @kibanamachine
[8.x] [OpenAPI][DOCS] Add descriptions, examples, responses for role …
c056931 
…APIs (#195527) (#197889)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs
(#195527)](#195527)

<!--- Backport version: 8.9.8 -->

### 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-25T17:13:57Z","message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","Feature:Security/Authorization","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"number":195527,"url":"https://github.com/elastic/kibana/pull/195527","mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195527","number":195527,"mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tsullivan tsullivan tsullivan approved these changes

@elena-shostak elena-shostak elena-shostak approved these changes

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs Feature:Security/Authorization Platform Security - Authorization release_note:skip Skip the PR/issue when compiling release notes Team:Security Platform Security: Auth, Users, Roles, Spaces, Audit Logging, etc t// v8.16.0 v8.17.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lcawl @elasticmachine @kibanamachine @tsullivan @elena-shostak