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.

Sign up for GitHub

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

[DOCS] Add severity field to case APIs #132289

Merged
merged 5 commits into from
May 19, 2022
Merged

[DOCS] Add severity field to case APIs #132289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2dbfca3
[DOCS] Add severity to create case API
lcawl May 16, 2022
766cc95
[DOCS] Add severity to update case API
lcawl May 16, 2022
9ccf91a
[DOCS] Adds severity to more case APIs
lcawl May 16, 2022
e671e5f
[DOCS] Add severity to push case API
lcawl May 16, 2022
fbfe75f
Merge branch 'main' into cases-severity
kibanamachine May 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-add-comment.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ The API returns details about the case and its comments. For example:
},
"owner": "cases",
"duration": null,
"severity": "low",
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-24T00:37:03.906Z",
Expand Down
5 changes: 5 additions & 0 deletions docs/api/cases/cases-api-create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@ An object that contains the case settings.
(Required, boolean) Turns alert syncing on or off.
====

`severity`::
(Optional,string) The severity of the case. Valid values are: `critical`, `high`,
`low`, and `medium`.

`tags`::
(Required, string array) The words and phrases that help
categorize cases. It can be an empty array.
Expand Down Expand Up @@ -206,6 +210,7 @@ the case identifier, version, and creation time. For example:
"owner": "securitySolution",
"description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active",
"duration": null,
"severity": "low",
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
5 changes: 5 additions & 0 deletions docs/api/cases/cases-api-find-cases.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ filters the objects in the response.
(Optional, string or array of strings) The fields to perform the
`simple_query_string` parsed query against.

`severity`::
(Optional,string) The severity of the case. Valid values are: `critical`, `high`,
`low`, and `medium`.

`sortField`::
(Optional, string) Determines which field is used to sort the results,
`createdAt` or `updatedAt`. Defaults to `createdAt`.
Expand Down Expand Up @@ -126,6 +130,7 @@ The API returns a JSON object listing the retrieved cases. For example:
},
"owner": "securitySolution",
"duration": null,
"severity": "low",
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-29T13:03:23.533Z",
Expand Down
Loading