[DOCS] Update prerequisites in delete case and comment APIs (#136998)

This commit is contained in:
Lisa Cawley 2022-07-25 07:52:23 -07:00 committed by GitHub
parent 68a161f6c9
commit 955cb3f354
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 31 additions and 26 deletions

View file

@ -14,10 +14,10 @@ Deletes one or more cases.
=== {api-prereq-title}
You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're deleting.
You must have `read` or `all` privileges and the `delete` sub-feature privilege
for the *Cases* feature in the *Management*, *{observability}*, or *Security*
section of the <<kibana-feature-privileges,{kib} feature privileges>>, depending
on the `owner` of the cases you're deleting.
=== {api-path-parms-title}

View file

@ -18,10 +18,10 @@ Deletes one or all comments and alerts from a case.
=== {api-prereq-title}
You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're updating.
You must have `read` or `all` privileges and the `delete` sub-feature privilege
for the *Cases* feature in the *Management*, *{observability}*, or *Security*
section of the <<kibana-feature-privileges,{kib} feature privileges>>, depending
on the `owner` of the cases you're updating.
=== {api-path-parms-title}

View file

@ -15,12 +15,14 @@ a|
* `All` for the *Cases* feature under *Management*.
* `All` for the *Actions and Connectors* feature under *Management*.
NOTE: The `All` *Actions and Connectors* feature privilege is required to
create, add, delete, and modify case connectors and to send updates to external
systems.
NOTE: The *Actions and Connectors* feature privilege is required to create, add,
delete, and modify case connectors and to send updates to external systems.
| Give view-only access for cases | `Read` for the *Cases* feature under *Management*.
| Give access to view and delete cases | `Read` for the *Cases* feature under
*Management* with the deletion sub-feature enabled.
| Revoke all access to cases | `None` for the *Cases* feature under *Management*.
|===

View file

@ -443,7 +443,7 @@
"delete": {
"summary": "Deletes one or more cases from the default space.",
"operationId": "deleteCaseDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
"description": "You must have `read` or `all` privileges and the `delete` sub-feature privilege for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
"tags": [
"cases",
"kibana"
@ -4061,7 +4061,7 @@
"delete": {
"summary": "Deletes one or more cases.",
"operationId": "deleteCase",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
"description": "You must have `read` or `all` privileges and the `delete` sub-feature privilege for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
"tags": [
"cases",
"kibana"

View file

@ -387,9 +387,10 @@ paths:
summary: Deletes one or more cases from the default space.
operationId: deleteCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
feature privileges, depending on the owner of the cases you're deleting.
You must have `read` or `all` privileges and the `delete` sub-feature
privilege for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature
privileges, depending on the owner of the cases you're deleting.
tags:
- cases
- kibana
@ -3395,10 +3396,10 @@ paths:
summary: Deletes one or more cases.
operationId: deleteCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the
Kibana feature privileges, depending on the owner of the cases you're
deleting.
You must have `read` or `all` privileges and the `delete` sub-feature
privilege for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature
privileges, depending on the owner of the cases you're deleting.
tags:
- cases
- kibana

View file

@ -72,9 +72,10 @@ delete:
summary: Deletes one or more cases from the default space.
operationId: deleteCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
feature privileges, depending on the owner of the cases you're deleting.
You must have `read` or `all` privileges and the `delete` sub-feature
privilege for the **Cases** feature in the **Management**, **Observability**,
or **Security** section of the Kibana feature privileges, depending on the
owner of the cases you're deleting.
tags:
- cases
- kibana

View file

@ -73,9 +73,10 @@ delete:
summary: Deletes one or more cases.
operationId: deleteCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
feature privileges, depending on the owner of the cases you're deleting.
You must have `read` or `all` privileges and the `delete` sub-feature
privilege for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,
depending on the owner of the cases you're deleting.
tags:
- cases
- kibana