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

Jump to bottom

[DOCS] Add duration to case API examples #132090

Merged
merged 5 commits into from
May 16, 2022
Merged

[DOCS] Add duration to case API examples #132090

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc0f3ca
[DOCS] Add duration to case API examples
lcawl May 12, 2022
9c2df36
[DOCS] Adds duration to examples in open API spec
lcawl May 12, 2022
85872a6
Add duration to case response properties in spec
lcawl May 12, 2022
2bb8099
Merge branch 'main' into case-duration
lcawl May 16, 2022
ab1b014
[DOCS] Addresses feedback about duration description
lcawl May 16, 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 @@ -119,6 +119,7 @@ The API returns details about the case and its comments. For example:
"syncAlerts":false
},
"owner": "cases",
"duration": null,
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-24T00:37:03.906Z",
Expand Down
1 change: 1 addition & 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 @@ -205,6 +205,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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
2 changes: 2 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 @@ -125,6 +125,7 @@ The API returns a JSON object listing the retrieved cases. For example:
"syncAlerts": true
},
"owner": "securitySolution",
"duration": null,
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-29T13:03:23.533Z",
Expand Down Expand Up @@ -164,6 +165,7 @@ The API returns a JSON object listing the retrieved cases. For example:
"syncAlerts": false
},
"owner": "cases",
"duration": null,
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-29T11:30:02.658Z",
Expand Down
2 changes: 2 additions & 0 deletions docs/api/cases/cases-api-get-case.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ The API returns a JSON object with the retrieved case. For example:
"version": "Wzk4LDFd",
"comments": [],
"totalComment": 0,
"totalAlerts": 0,
"closed_at": null,
"closed_by": null,
"created_at": "2020-03-29T11:30:02.658Z",
Expand Down Expand Up @@ -90,6 +91,7 @@ The API returns a JSON object with the retrieved case. For example:
"syncAlerts": true
},
"owner": "securitySolution",
"duration": null,
"tags": [
"phishing",
"social engineering",
Expand Down
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-push.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ The API returns a JSON object representing the pushed case. For example:
"syncAlerts": true
},
"owner": "securitySolution",
"duration": null,
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-29T11:30:02.658Z",
Expand Down
23 changes: 12 additions & 11 deletions docs/api/cases/cases-api-update-comment.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,35 +106,36 @@ The API returns details about the case and its comments. For example:
"comments":[{
"id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
"version": "WzIwNjM3LDFd",
"comment":"That is nothing - Ethan Hunt answered a targeted social media campaign promoting phishy pension schemes to IMF operatives. Even worse, he likes baked beans.",
"type":"user",
"owner":"cases",
"created_at":"2022-03-24T00:37:10.832Z",
"comment": "That is nothing - Ethan Hunt answered a targeted social media campaign promoting phishy pension schemes to IMF operatives. Even worse, he likes baked beans.",
"type": "user",
"owner": "cases",
"created_at": "2022-03-24T00:37:10.832Z",
"created_by": {
"email": "moneypenny@hms.gov.uk",
"full_name": "Ms Moneypenny",
"username": "moneypenny"
},
"pushed_at":null,
"pushed_by":null,
"updated_at":"2022-03-24T01:27:06.210Z",
"pushed_at": null,
"pushed_by": null,
"updated_at": "2022-03-24T01:27:06.210Z",
"updated_by": {
"email": "jbond@hms.gov.uk",
"full_name": "James Bond",
"username": "_007"
}
}
],
"totalAlerts":0,
"totalAlerts": 0,
"id": "293f1bc0-74f6-11ea-b83a-553aecdb28b6",
"version": "WzIwNjM2LDFd",
"totalComment": 1,
"title": "This case will self-destruct in 5 seconds",
"tags": ["phishing","social engineering"],
"tags": ["phishing","social engineering"],
"description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants.",
"settings": {"syncAlerts":false},
"owner": "cases","
closed_at": null,
"owner": "cases",
"duration": null,
"closed_at": null,
"closed_by": null,
"created_at": "2022-03-24T00:37:03.906Z",
"created_by": {
Expand Down
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-update.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ The API returns the updated case with a new `version` value. 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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
22 changes: 22 additions & 0 deletions x-pack/plugins/cases/docs/openapi/bundled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,11 @@
"type": "string",
"example": "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": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If an error occurs or the case has not been closed, the duration is set to null.",
lcawl marked this conversation as resolved.
Show resolved Hide resolved
"example": 120
},
"external_service": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -821,6 +826,11 @@
"type": "string",
"example": "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": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If an error occurs or the case has not been closed, the duration is set to null.",
"example": 120
},
"external_service": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1267,6 +1277,11 @@
"type": "string",
"example": "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": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If an error occurs or the case has not been closed, the duration is set to null.",
"example": 120
},
"external_service": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1753,6 +1768,11 @@
"type": "string",
"example": "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": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If an error occurs or the case has not been closed, the duration is set to null.",
"example": 120
},
"external_service": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1994,6 +2014,7 @@
},
"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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down Expand Up @@ -2068,6 +2089,7 @@
},
"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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
30 changes: 30 additions & 0 deletions x-pack/plugins/cases/docs/openapi/bundled.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,13 @@ paths:
advertising cheap holidays for underpaid civil servants.
Operation bubblegum is active. Repeat - operation
bubblegum is now active
duration:
type: integer
description: >-
The elapsed time from the creation of the case to its
closure (in seconds). If an error occurs or the case has
not been closed, the duration is set to null.
example: 120
external_service:
type: object
properties:
Expand Down Expand Up @@ -732,6 +739,13 @@ paths:
advertising cheap holidays for underpaid civil servants.
Operation bubblegum is active. Repeat - operation
bubblegum is now active
duration:
type: integer
description: >-
The elapsed time from the creation of the case to its
closure (in seconds). If an error occurs or the case has
not been closed, the duration is set to null.
example: 120
external_service:
type: object
properties:
Expand Down Expand Up @@ -1117,6 +1131,13 @@ paths:
advertising cheap holidays for underpaid civil servants.
Operation bubblegum is active. Repeat - operation
bubblegum is now active
duration:
type: integer
description: >-
The elapsed time from the creation of the case to its
closure (in seconds). If an error occurs or the case has
not been closed, the duration is set to null.
example: 120
external_service:
type: object
properties:
Expand Down Expand Up @@ -1533,6 +1554,13 @@ paths:
advertising cheap holidays for underpaid civil servants.
Operation bubblegum is active. Repeat - operation
bubblegum is now active
duration:
type: integer
description: >-
The elapsed time from the creation of the case to its
closure (in seconds). If an error occurs or the case has
not been closed, the duration is set to null.
example: 120
external_service:
type: object
properties:
Expand Down Expand Up @@ -1709,6 +1737,7 @@ components:
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
closed_at: null
closed_by: null
created_at: '2022-05-13T09:16:17.416Z'
Expand Down Expand Up @@ -1774,6 +1803,7 @@ components:
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
closed_at: null
closed_by: null
created_at: '2022-05-13T09:16:17.416Z'
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ value:
},
"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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ value:
},
"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,
"closed_at": null,
"closed_by": null,
"created_at": "2022-05-13T09:16:17.416Z",
Expand Down
4 changes: 4 additions & 0 deletions x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ created_by:
description:
type: string
example: "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:
type: integer
description: The elapsed time from the creation of the case to its closure (in seconds). If an error occurs or the case has not been closed, the duration is set to null.
example: 120
external_service:
type: object
properties:
Expand Down