Skip to content

Commit

Permalink
[8.16] [OpenAPI][DOCS] Add descriptions, examples, responses for role…
Browse files Browse the repository at this point in the history
… 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":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-25T17:13:57Z","message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<[email protected]>","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
<[email protected]>","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
<[email protected]>","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 <[email protected]>
  • Loading branch information
lcawl and kibanamachine authored Oct 28, 2024
1 parent e060bee commit f5e7c9b
Show file tree
Hide file tree
Showing 35 changed files with 1,448 additions and 20,051 deletions.
18 changes: 1 addition & 17 deletions docs/api/role-management.asciidoc
Original file line number Diff line number Diff line change
@@ -1,24 +1,8 @@
[role="xpack"]
[[role-management-api]]
== {kib} role management APIs

Manage the roles that grant <<kibana-privileges, {kib} privileges>>.

WARNING: Do not use the {ref}/security-api.html#security-role-apis[{es} role management APIs] to manage {kib} roles.

The following {kib} role management APIs are available:

* <<role-management-api-put, Create or update role API>> to create a new {kib} role, or update the attributes of an existing role
* <<role-management-api-put-bulk, Bulk create or update roles API>> to create a new {kib} roles, or update the attributes of existing roles

* <<role-management-api-get, Get all {kib} roles API>> to retrieve all {kib} roles

* <<role-management-specific-api-get, Get specific role API>> to retrieve a specific role

* <<role-management-api-delete, Delete role API>> to delete a {kib} role

include::role-management/put.asciidoc[]
include::role-management/get.asciidoc[]
include::role-management/get-all.asciidoc[]
include::role-management/delete.asciidoc[]
include::role-management/put-bulk.asciidoc[]
For the latest API details, refer to {api-kibana}/group/endpoint-roles[role APIs].
26 changes: 0 additions & 26 deletions docs/api/role-management/delete.asciidoc

This file was deleted.

80 changes: 0 additions & 80 deletions docs/api/role-management/get-all.asciidoc

This file was deleted.

106 changes: 0 additions & 106 deletions docs/api/role-management/get.asciidoc

This file was deleted.

Loading

0 comments on commit f5e7c9b

Please sign in to comment.