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] Add descriptions, examples, responses for role APIs #195527

Merged
merged 11 commits into from
Oct 25, 2024
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