Skip to content

Commit

Permalink
updates structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben Skelker committed Jan 19, 2020
1 parent 701c862 commit fd2bb02
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 51 deletions.
28 changes: 1 addition & 27 deletions docs/en/siem/cases-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,7 @@ Creates a new case.

A JSON object with these fields:

[width="100%",options="header"]
|==============================================
|Name |Type |Description |Required

|`title` |String |The case's title. |Yes
|`description` |String |The case's description. |Yes
|`case_type` |String |The type of case. For example, `security`. |Yes
|`state` |String a|Indicates whether the case is open or closed. Valid values
are:

* `open`
* `closed`

|No, defaults to `open`.
|assignees |Object[] a|Object containing string arrays for the names of people
assigned to the case:

* `username` (String, required) - The username of the person assigned to the
case.
* `full_name` (String, optional) - The full name of the person assigned to the
object.

|No, defaults to an empty array.

|`tags` |String[] |String array containing words and phrases that help categorize
cases. |No, defaults to an empty array.
|==============================================
include::shared-content/case-schema.asciidoc[tag=cases-api-json-schema]

===== Example request

Expand Down
25 changes: 1 addition & 24 deletions docs/en/siem/cases-api-update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,7 @@ The URL must include the `case ID` of the case you are updating.

A JSON object with the fields you are updating:

[width="100%",options="header"]
|==============================================
|Name |Type |Description

|`title` |String |The case's title.
|`description` |String |The case's description.
|`case_type` |String |The type of case. For example, `security`.
|`state` |String a|Indicates whether the case is open or closed. Valid values
are:

* `open`
* `closed`

|assignees |Object[] a|Object containing string arrays for the names of people
assigned to the case:

* `username` (String, required) - The username of the person assigned to the
case.
* `full_name` (String, optional) - The full name of the person assigned to the
object.

|`tags` |String[] |String array containing words and phrases that help categorize
cases.
|==============================================
include::shared-content/case-schema.asciidoc[tag=cases-api-json-schema]

===== Example request

Expand Down
29 changes: 29 additions & 0 deletions docs/en/siem/shared-content/case-schema.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// tag::cases-api-json-schema[]
[width="100%",options="header"]
|==============================================
|Name |Type |Description |Required

|`title` |String |The case's title. |Yes
|`description` |String |The case's description. |Yes
|`case_type` |String |The type of case. For example, `security`. |Yes
|`state` |String a|Indicates whether the case is open or closed. Valid values
are:

* `open`
* `closed`
|No, defaults to `open`.
|assignees |Object[] a|Object containing string arrays for the names of people
assigned to the case:

* `username` (String, required) - The username of the person assigned to the
case.
* `full_name` (String, optional) - The full name of the person assigned to the
object.
|No, defaults to an empty array.

|`tags` |String[] |String array containing words and phrases that help categorize
cases. |No, defaults to an empty array.
|==============================================
// end::cases-api-json-schema[]

0 comments on commit fd2bb02

Please sign in to comment.