github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Clarify case duration (#133552)

Browse source 
Co-authored-by: Eric Davis <eric.davis@elastic.co>
This commit is contained in:
Lisa Cawley 2022-06-06 08:45:38 -07:00 • committed by GitHub
parent b1d9e76eb6
commit 9ca93a552c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 42 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/cases/cases-api-find-cases.asciidoc
View file

@ -124,7 +124,7 @@ The API returns a JSON object listing the retrieved cases. For example:
"description": "Case description",
"settings": { "syncAlerts": true },
"owner": "securitySolution",
"duration": null,
"duration": null, <1>
"severity": "low",
"closed_at": null,
"closed_by": null,
@ -155,3 +155,7 @@ The API returns a JSON object listing the retrieved cases. For example:
"count_closed_cases": 0
}
--------------------------------------------------
<1> Duration represents the elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the duration is set to
`null`. If the case was closed after less than half a second, the duration is
rounded down to zero.

8
docs/api/cases/cases-api-get-case.asciidoc
View file

@ -92,11 +92,15 @@ The API returns a JSON object with the retrieved case. For example:
},
"owner": "securitySolution",
"severity": "low",
"duration": null,
"duration": null, <1>
"tags": [
"phishing",
"social engineering",
"bubblegum"
]
}
--------------------------------------------------
--------------------------------------------------
<1> Duration represents the elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the duration is set to
`null`. If the case was closed after less than half a second, the duration is
rounded down to zero.

12
x-pack/plugins/cases/docs/openapi/bundled.json
View file

@ -346,7 +346,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {
@ -837,7 +837,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {
@ -1315,7 +1315,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {
@ -2740,7 +2740,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {
@ -3237,7 +3237,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {
@ -3716,7 +3716,7 @@
},
"duration": {
"type": "integer",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null.",
"description": "The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.\n",
"example": 120
},
"external_service": {

32
x-pack/plugins/cases/docs/openapi/bundled.yaml
View file

@ -323,10 +323,11 @@ paths:
bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the
duration is set to null.
duration is set to null. If the case was closed after less
than half a second, the duration is rounded down to zero.
example: 120
external_service:
type: object
@ -749,10 +750,11 @@ paths:
bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the
duration is set to null.
duration is set to null. If the case was closed after less
than half a second, the duration is rounded down to zero.
example: 120
external_service:
type: object
@ -1128,10 +1130,12 @@ paths:
Repeat - operation bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to
its closure (in seconds). If the case has not been
closed, the duration is set to null.
closed, the duration is set to null. If the case was
closed after less than half a second, the duration
is rounded down to zero.
example: 120
external_service:
type: object
@ -2389,10 +2393,11 @@ paths:
bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the
duration is set to null.
duration is set to null. If the case was closed after less
than half a second, the duration is rounded down to zero.
example: 120
external_service:
type: object
@ -2817,10 +2822,11 @@ paths:
bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to its
closure (in seconds). If the case has not been closed, the
duration is set to null.
duration is set to null. If the case was closed after less
than half a second, the duration is rounded down to zero.
example: 120
external_service:
type: object
@ -3199,10 +3205,12 @@ paths:
Repeat - operation bubblegum is now active
duration:
type: integer
description: >-
description: >
The elapsed time from the creation of the case to
its closure (in seconds). If the case has not been
closed, the duration is set to null.
closed, the duration is set to null. If the case was
closed after less than half a second, the duration
is rounded down to zero.
example: 120
external_service:
type: object

6
x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml
View file

@ -44,7 +44,11 @@ description:
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 the case has not been closed, the duration is set to null.
description: >
The elapsed time from the creation of the case to its closure (in seconds).
If the case has not been closed, the duration is set to null. If the case
was closed after less than half a second, the duration is rounded down to
zero.
example: 120
external_service:
type: object