kibana/docs/api
Lisa Cawley f5e7c9b963
[8.16] [OpenAPI][DOCS] Add descriptions, examples, responses for role 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)](https://github.com/elastic/kibana/pull/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>
2024-10-28 18:28:37 +01:00
..
dashboard [DOCS] Remove saved object and data view API pages (#190654) 2024-08-20 17:29:06 +00:00
index-patterns [DOCS] Remove saved object and data view API pages (#190654) 2024-08-20 17:29:06 +00:00
logstash-configuration-management Add a note that if list pipelines exceeds 10k, Kibana faces performan… (#131992) 2022-05-11 16:24:16 -07:00
osquery-manager [8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352) 2024-10-15 16:00:44 +00:00
session-management Expose session invalidation API. (#92376) 2021-03-24 09:54:08 +01:00
short-urls Short url docs (#113084) 2021-10-12 19:46:58 +02:00
synthetics [Synthetics] Delete monitor API via id param !! (#190210) 2024-08-12 21:13:33 +02:00
task-manager Fix task manager polling flow controls (#153491) 2023-05-03 09:33:10 -04:00
upgrade-assistant Fixed some typos (#125802) 2022-03-02 16:40:34 -06:00
uptime [Uptime] Settings public API (#163400) 2023-10-23 06:14:37 -07:00
actions-and-connectors.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
alerting.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
cases.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
dashboard-api.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
data-views.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
features.asciidoc Timelion App removal (#110255) 2021-09-10 14:53:07 +03:00
index-patterns.asciidoc [DOCS] Add deprecated index pattern APIs (#124065) 2022-01-31 15:47:25 -08:00
logstash-configuration-management.asciidoc [DOCS] Updates API requests and examples (#60695) 2020-03-20 16:33:20 -05:00
machine-learning.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
osquery-manager.asciidoc [8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352) 2024-10-15 16:00:44 +00:00
role-management.asciidoc [8.16] [OpenAPI][DOCS] Add descriptions, examples, responses for role APIs (#195527) (#197890) 2024-10-28 18:28:37 +01:00
saved-objects.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
session-management.asciidoc Expose session invalidation API. (#92376) 2021-03-24 09:54:08 +01:00
short-urls.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
spaces-management.asciidoc [8.16] [DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333) (#196943) 2024-10-18 15:43:40 -05:00
upgrade-assistant.asciidoc [DOCS] Adds missing add default field API (#86332) 2020-12-17 13:59:56 -06:00
uptime-api.asciidoc [Uptime] Settings public API (#163400) 2023-10-23 06:14:37 -07:00