github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.5] [DOCS] Add assignees to case APIs (#143610) (#143810)

Browse source 
(cherry picked from commit 6eb02d096f)
This commit is contained in:
Lisa Cawley 2022-10-20 19:31:58 -07:00 • committed by GitHub
parent 4bab938fdb
commit af288128e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 184 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/api/cases/cases-api-create.asciidoc
View file

@ -28,6 +28,18 @@ default space is used.
[role="child_attributes"]
=== {api-request-body-title}
`assignees`::
(Optional, array of objects) Array containing users that are assigned to the case.
+
.Properties of assignee objects
[%collapsible%open]
=====
`uid`::
(Required, string) A unique identifier for the user profile. These identifiers
can be found by using the
{ref}/security-api-suggest-user-profile.html[suggest user profile API].
=====
`connector`::
(Required, object) An object that contains the connector configuration.
+
@ -201,6 +213,7 @@ the case identifier, version, and creation time. For example:
"totalAlerts": 0,
"title": "Case title 1",
"tags": [ "tag 1" ],
"assignees": [],
"settings": {
"syncAlerts": true
},

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

@ -141,6 +141,7 @@ The API returns a JSON object listing the retrieved cases. For example:
"full_name": "Joe Smith",
"username": "jsmith"
},
"assignees": [],
"connector": {
"id": "none",
"name": "none",

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

@ -86,6 +86,7 @@ The API returns a JSON object with the retrieved case. For example:
"status":"open",
"updated_at":"2022-07-13T15:40:32.335Z",
"updated_by":{"full_name":null,"email":null,"username":"elastic"},
"assignees":[{"uid":"u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"}],
"connector":{"id":"none","name":"none","type":".none","fields":null},
"external_service":null
}

14
docs/api/cases/cases-api-update.asciidoc
View file

@ -34,6 +34,19 @@ default space is used.
.Properties of `cases` objects
[%collapsible%open]
====
`assignees`::
(Optional, array of objects) Array containing users that are assigned to the case.
+
.Properties of assignee objects
[%collapsible%open]
=====
`uid`::
(Required, string) A unique identifier for the user profile. These identifiers
can be found by using the
{ref}/security-api-suggest-user-profile.html[suggest user profile API].
=====
`connector`::
(Optional, object) An object that contains the connector configuration.
+
@ -197,6 +210,7 @@ PATCH api/cases
},
"description": "A new description.",
"tags": [ "tag-1", "tag-2" ],
"assignees": [],
"settings": {
"syncAlerts": true
}

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

@ -816,6 +816,24 @@
"title"
],
"properties": {
"assignees": {
"type": "array",
"description": "An array containing users that are assigned to the case.",
"nullable": true,
"items": {
"type": "object",
"required": [
"uid"
],
"properties": {
"uid": {
"type": "string",
"description": "A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.",
"example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
}
}
}
},
"connector": {
"oneOf": [
{
@ -1272,6 +1290,24 @@
"version"
],
"properties": {
"assignees": {
"type": "array",
"description": "An array containing users that are assigned to the case.",
"nullable": true,
"items": {
"type": "object",
"required": [
"uid"
],
"properties": {
"uid": {
"type": "string",
"description": "A unique identifier for the user profile. You can use the get user profile API to retrieve more details.",
"example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
}
}
}
},
"closed_at": {
"type": "string",
"format": "date-time",
@ -1417,6 +1453,24 @@
"version"
],
"properties": {
"assignees": {
"type": "array",
"description": "An array containing users that are assigned to the case.",
"nullable": true,
"items": {
"type": "object",
"required": [
"uid"
],
"properties": {
"uid": {
"type": "string",
"description": "A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.",
"example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
}
}
}
},
"connector": {
"oneOf": [
{
@ -1746,6 +1800,7 @@
"tags": [
"tag 1"
],
"assignees": [],
"description": "A case description.",
"settings": {
"syncAlerts": false
@ -1840,6 +1895,7 @@
"full_name": null,
"username": "elastic"
},
"assignees": [],
"connector": {
"id": "131d4448-abe0-4789-939d-8ef60680b498",
"name": "My connector",

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

@ -560,6 +560,19 @@ components:
- tags
- title
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
connector:
oneOf:
- $ref: '#/components/schemas/connector_properties_none'
@ -896,6 +909,19 @@ components:
- updated_by
- version
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
closed_at:
type: string
format: date-time
@ -992,6 +1018,19 @@ components:
- id
- version
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
connector:
oneOf:
- $ref: '#/components/schemas/connector_properties_none'
@ -1222,6 +1261,7 @@ components:
title: Case title 1
tags:
- tag 1
assignees: []
description: A case description.
settings:
syncAlerts: false
@ -1296,6 +1336,7 @@ components:
email: null
full_name: null
username: elastic
assignees: []
connector:
id: 131d4448-abe0-4789-939d-8ef60680b498
name: My connector

1
x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml
View file

@ -8,6 +8,7 @@ value:
title: Case title 1
tags:
- tag 1
assignees: []
description: A case description.
settings:
syncAlerts: false

1
x-pack/plugins/cases/docs/openapi/components/examples/find_case_response.yaml
View file

@ -33,6 +33,7 @@ value:
"full_name": null,
"username": "elastic"
},
"assignees": [],
"connector": {
"id": "none",
"name": "none",

4
x-pack/plugins/cases/docs/openapi/components/examples/get_case_response.yaml
View file

@ -34,7 +34,9 @@ value:
"created_at":"2022-07-13T15:33:50.604Z",
"created_by":{"username":"elastic","email":null,"full_name":null},"status":"open",
"updated_at":"2022-07-13T15:40:32.335Z",
"updated_by":{"full_name":null,"email":null,"username":"elastic"},"connector":{
"updated_by":{"full_name":null,"email":null,"username":"elastic"},
"assignees":[{"uid":"u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"}],
"connector":{
"id":"none",
"name":"none",
"type":".none",

1
x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml
View file

@ -31,6 +31,7 @@ value:
"full_name": null,
"username": "elastic"
},
"assignees": [],
"connector": {
"id": "131d4448-abe0-4789-939d-8ef60680b498",
"name": "My connector",

1
x-pack/plugins/cases/docs/openapi/components/schemas/action_types.yaml
View file

@ -1,6 +1,7 @@
type: string
description: The type of action.
enum:
- assignees
- create_case
- comment
- connector

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

@ -22,7 +22,20 @@ required:
- updated_at
- updated_by
- version
properties:
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
closed_at:
type: string
format: date-time

13
x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml
View file

@ -10,6 +10,19 @@ required:
- tags
- title
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
connector:
oneOf:
- $ref: 'connector_properties_none.yaml'

9
x-pack/plugins/cases/docs/openapi/components/schemas/payload_assignees.yaml Normal file
View file

@ -0,0 +1,9 @@
type: object
properties:
assignees:
type: array
items:
type: object
properties:
uid:
type: string

15
x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml
View file

@ -13,7 +13,20 @@ properties:
required:
- id
- version
properties:
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
connector:
oneOf:
- $ref: 'connector_properties_none.yaml'

1
x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml
View file

@ -24,6 +24,7 @@ properties:
payload:
oneOf:
- $ref: 'payload_alert_comment.yaml'
- $ref: 'payload_assignees.yaml'
- $ref: 'payload_connector.yaml'
- $ref: 'payload_create_case.yaml'
- $ref: 'payload_description.yaml'