From 91d59cea7c56481d2d52178ef47f0ac3ce7758c3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 18 Oct 2022 18:17:47 -0700 Subject: [PATCH 1/9] Add assignees to cases OAS --- .../cases/docs/openapi/bundled-min.json | 43 +++++++++++++++++++ .../cases/docs/openapi/bundled-min.yaml | 31 +++++++++++++ .../examples/create_case_response.yaml | 1 + .../examples/find_case_response.yaml | 1 + .../examples/get_case_response.yaml | 4 +- .../examples/update_case_response.yaml | 1 + .../components/schemas/action_types.yaml | 1 + .../schemas/case_response_properties.yaml | 11 ++++- .../schemas/create_case_request.yaml | 10 +++++ .../components/schemas/payload_assignees.yaml | 9 ++++ .../schemas/update_case_request.yaml | 12 +++++- .../user_actions_response_properties.yaml | 1 + 12 files changed, 122 insertions(+), 3 deletions(-) create mode 100644 x-pack/plugins/cases/docs/openapi/components/schemas/payload_assignees.yaml diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.json b/x-pack/plugins/cases/docs/openapi/bundled-min.json index 02e04d2b2fbdd..ab93240249347 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.json +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.json @@ -816,6 +816,20 @@ "title" ], "properties": { + "assignees": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "A user identifier to assign to the case.", + "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } + } + } + }, "connector": { "oneOf": [ { @@ -1272,6 +1286,19 @@ "version" ], "properties": { + "assignees": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } + } + } + }, "closed_at": { "type": "string", "format": "date-time", @@ -1417,6 +1444,20 @@ "version" ], "properties": { + "assignees": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "A user identifier to assign to the case.", + "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } + } + } + }, "connector": { "oneOf": [ { @@ -1746,6 +1787,7 @@ "tags": [ "tag 1" ], + "assignees": [], "description": "A case description.", "settings": { "syncAlerts": false @@ -1840,6 +1882,7 @@ "full_name": null, "username": "elastic" }, + "assignees": [], "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "My connector", diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml index d90783ccb7309..f4b35f119816b 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml @@ -560,6 +560,16 @@ components: - tags - title properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + description: A user identifier to assign to the case. + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 connector: oneOf: - $ref: '#/components/schemas/connector_properties_none' @@ -896,6 +906,15 @@ components: - updated_by - version properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 closed_at: type: string format: date-time @@ -992,6 +1011,16 @@ components: - id - version properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + description: A user identifier to assign to the case. + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 connector: oneOf: - $ref: '#/components/schemas/connector_properties_none' @@ -1222,6 +1251,7 @@ components: title: Case title 1 tags: - tag 1 + assignees: [] description: A case description. settings: syncAlerts: false @@ -1296,6 +1326,7 @@ components: email: null full_name: null username: elastic + assignees: [] connector: id: 131d4448-abe0-4789-939d-8ef60680b498 name: My connector diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml index 7d9cdf3626c72..8cd80595abf30 100644 --- a/x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/examples/create_case_response.yaml @@ -8,6 +8,7 @@ value: title: Case title 1 tags: - tag 1 + assignees: [] description: A case description. settings: syncAlerts: false diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/find_case_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/find_case_response.yaml index 1c8168dde7708..6f744d03a1365 100644 --- a/x-pack/plugins/cases/docs/openapi/components/examples/find_case_response.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/examples/find_case_response.yaml @@ -33,6 +33,7 @@ value: "full_name": null, "username": "elastic" }, + "assignees": [], "connector": { "id": "none", "name": "none", diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/get_case_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/get_case_response.yaml index 936a21a5cfc70..bd74fa423bb9c 100644 --- a/x-pack/plugins/cases/docs/openapi/components/examples/get_case_response.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/examples/get_case_response.yaml @@ -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", diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml index 7413547e6ff60..eaf421771b51e 100644 --- a/x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/examples/update_case_response.yaml @@ -31,6 +31,7 @@ value: "full_name": null, "username": "elastic" }, + "assignees": [], "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "My connector", diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/action_types.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/action_types.yaml index 05e3fc6ab04b7..3568008b07000 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/action_types.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/action_types.yaml @@ -1,6 +1,7 @@ type: string description: The type of action. enum: + - assignees - create_case - comment - connector diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml index a53d88f3be69b..90726528897ab 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml @@ -22,7 +22,16 @@ required: - updated_at - updated_by - version -properties: +properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 closed_at: type: string format: date-time diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml index ab6b49c653668..77c9c8e0500dd 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml @@ -10,6 +10,16 @@ required: - tags - title properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + description: A user identifier to assign to the case. + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 connector: oneOf: - $ref: 'connector_properties_none.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_assignees.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_assignees.yaml new file mode 100644 index 0000000000000..122541dfe4fe6 --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_assignees.yaml @@ -0,0 +1,9 @@ +type: object +properties: + assignees: + type: array + items: + type: object + properties: + uid: + type: string \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml index f6feac43b1613..bb137274ef7dc 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml @@ -13,7 +13,17 @@ properties: required: - id - version - properties: + properties: + assignees: + type: array + nullable: true + items: + type: object + properties: + uid: + type: string + description: A user identifier to assign to the case. + example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0 connector: oneOf: - $ref: 'connector_properties_none.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml index e828f3441cb5d..a3f57ed53297d 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml @@ -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' From bf2205a2c9601837752d6fab0c8e172d271d14b3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 18 Oct 2022 18:18:09 -0700 Subject: [PATCH 2/9] [DOCS] Add assignees to case APIs --- docs/api/cases/cases-api-create.asciidoc | 10 ++++++++++ docs/api/cases/cases-api-find-cases.asciidoc | 1 + docs/api/cases/cases-api-update.asciidoc | 10 ++++++++++ 3 files changed, 21 insertions(+) diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc index 5eec612d8bfca..de654903e10ef 100644 --- a/docs/api/cases/cases-api-create.asciidoc +++ b/docs/api/cases/cases-api-create.asciidoc @@ -34,6 +34,15 @@ default space is used. [role="child_attributes"] === {api-request-body-title} +`assignees`:: +(Optional, array of objects) +.Properties of `assignees` objects +[%collapsible%open] +===== +`uid`:: A user identifier to assign to the case. +// TBD How are these values found? +===== + `connector`:: (Required, object) An object that contains the connector configuration. + @@ -207,6 +216,7 @@ the case identifier, version, and creation time. For example: "totalAlerts": 0, "title": "Case title 1", "tags": [ "tag 1" ], + "assignees": [], "settings": { "syncAlerts": true }, diff --git a/docs/api/cases/cases-api-find-cases.asciidoc b/docs/api/cases/cases-api-find-cases.asciidoc index d7ae5fed35b0f..770e1d30ee594 100644 --- a/docs/api/cases/cases-api-find-cases.asciidoc +++ b/docs/api/cases/cases-api-find-cases.asciidoc @@ -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", diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index 30c482da4282c..79b69c6769851 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -40,6 +40,15 @@ default space is used. .Properties of `cases` objects [%collapsible%open] ==== +`assignees`:: +(Optional, array of objects) +.Properties of `assignees` objects +[%collapsible%open] +===== +`uid`:: A user identifier to assign to the case. +// TBD How are these values found? +===== + `connector`:: (Optional, object) An object that contains the connector configuration. + @@ -203,6 +212,7 @@ PATCH api/cases }, "description": "A new description.", "tags": [ "tag-1", "tag-2" ], + "assignees": [], "settings": { "syncAlerts": true } From 9a5ba582a1cc11ad05f9a8379d4d8e8880aadd2d Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 18 Oct 2022 18:21:00 -0700 Subject: [PATCH 3/9] [DOCS] Re-generate case API docs --- .../cases/case-apis-passthru.asciidoc | 560 +++--------------- 1 file changed, 94 insertions(+), 466 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index d10933c5b0a9c..2a07283aa98e0 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -19,11 +19,8 @@ Any modifications made to this file will be overwritten.

Cases

@@ -105,118 +102,28 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, - "updated_at" : "2000-01-23T04:56:07.000+00:00", - "updated_by" : { - "full_name" : "full_name", - "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", - "email" : "email", - "username" : "elastic" - }, - "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192", - "external_service" : { - "external_title" : "external_title", - "pushed_by" : { - "full_name" : "full_name", - "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", - "email" : "email", - "username" : "elastic" + "connector" : { + "name" : "none", + "id" : "none", + "fields" : { + "destIp" : "destIp", + "severity" : "severity", + "parent" : "parent", + "impact" : "impact", + "malwareUrl" : "malwareUrl", + "priority" : "priority", + "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], + "issueType" : "issueType", + "sourceIp" : "sourceIp", + "urgency" : "urgency", + "malwareHash" : "malwareHash", + "caseId" : "caseId", + "severityCode" : 6.027456183070403, + "category" : "category", + "subcategory" : "subcategory" }, - "external_url" : "external_url", - "pushed_at" : "2000-01-23T04:56:07.000+00:00", - "connector_id" : "connector_id", - "external_id" : "external_id", - "connector_name" : "connector_name" - } -} - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Indicates a successful call. - case_response_properties - -
-
-
- Up - 
post /s/{spaceId}/api/cases
-
Creates a case. (createCase)
-
You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case you're creating.
- -

Path parameters

-
-
spaceId (required)
- -
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
-
- -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
create_case_request create_case_request (required)
- -
Body Parameter —
- -
- -

Request headers

-
-
kbn-xsrf (required)
- -
Header Parameter — default: null
- -
- - - -

Return type

-
- case_response_properties - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "owner" : "cases",
-  "totalComment" : 0,
-  "settings" : {
-    "syncAlerts" : true
-  },
-  "totalAlerts" : 0,
-  "closed_at" : "2000-01-23T04:56:07.000+00:00",
-  "comments" : [ null, null ],
-  "created_at" : "2022-05-13T09:16:17.416Z",
-  "description" : "A case description.",
-  "title" : "Case title 1",
-  "created_by" : {
-    "full_name" : "full_name",
-    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
-    "email" : "email",
-    "username" : "elastic"
-  },
-  "version" : "WzUzMiwxXQ==",
-  "closed_by" : {
-    "full_name" : "full_name",
-    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
-    "email" : "email",
-    "username" : "elastic"
+    "type" : ".none"
   },
-  "tags" : [ "tag-1" ],
-  "duration" : 120,
   "updated_at" : "2000-01-23T04:56:07.000+00:00",
   "updated_by" : {
     "full_name" : "full_name",
@@ -254,49 +161,6 @@ Any modifications made to this file will be overwritten.
         case_response_properties
-
-
- Up - 
delete /s/{spaceId}/api/cases
-
Deletes one or more cases. (deleteCase)
-
You must have read or all privileges and the delete sub-feature privilege for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
- -

Path parameters

-
-
spaceId (required)
- -
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
-
- - - -

Request headers

-
-
kbn-xsrf (required)
- -
Header Parameter — default: null
- -
- -

Query parameters

-
-
ids (required)
- -
Query Parameter — The cases that you want to removed. All non-ASCII characters must be URL encoded. default: null
-
- - - - - - - -

Responses

-

204

- Indicates a successful call. - -
-
Up @@ -394,118 +258,28 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, - "updated_at" : "2000-01-23T04:56:07.000+00:00", - "updated_by" : { - "full_name" : "full_name", - "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", - "email" : "email", - "username" : "elastic" - }, - "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192", - "external_service" : { - "external_title" : "external_title", - "pushed_by" : { - "full_name" : "full_name", - "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", - "email" : "email", - "username" : "elastic" + "connector" : { + "name" : "none", + "id" : "none", + "fields" : { + "destIp" : "destIp", + "severity" : "severity", + "parent" : "parent", + "impact" : "impact", + "malwareUrl" : "malwareUrl", + "priority" : "priority", + "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], + "issueType" : "issueType", + "sourceIp" : "sourceIp", + "urgency" : "urgency", + "malwareHash" : "malwareHash", + "caseId" : "caseId", + "severityCode" : 6.027456183070403, + "category" : "category", + "subcategory" : "subcategory" }, - "external_url" : "external_url", - "pushed_at" : "2000-01-23T04:56:07.000+00:00", - "connector_id" : "connector_id", - "external_id" : "external_id", - "connector_name" : "connector_name" - } -} - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Indicates a successful call. - case_response_properties -
-
-
-
- Up - 
patch /s/{spaceId}/api/cases
-
Updates one or more cases. (updateCase)
-
You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case you're updating.
- -

Path parameters

-
-
spaceId (required)
- -
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
-
- -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
- -

Request body

-
-
update_case_request update_case_request (optional)
- -
Body Parameter —
- -
- -

Request headers

-
-
kbn-xsrf (required)
- -
Header Parameter — default: null
- -
- - - -

Return type

-
- array[case_response_properties] - -
- - - -

Example data

-
Content-Type: application/json
- 
{
-  "owner" : "cases",
-  "totalComment" : 0,
-  "settings" : {
-    "syncAlerts" : true
-  },
-  "totalAlerts" : 0,
-  "closed_at" : "2000-01-23T04:56:07.000+00:00",
-  "comments" : [ null, null ],
-  "created_at" : "2022-05-13T09:16:17.416Z",
-  "description" : "A case description.",
-  "title" : "Case title 1",
-  "created_by" : {
-    "full_name" : "full_name",
-    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
-    "email" : "email",
-    "username" : "elastic"
+    "type" : ".none"
   },
-  "version" : "WzUzMiwxXQ==",
-  "closed_by" : {
-    "full_name" : "full_name",
-    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
-    "email" : "email",
-    "username" : "elastic"
-  },
-  "tags" : [ "tag-1" ],
-  "duration" : 120,
   "updated_at" : "2000-01-23T04:56:07.000+00:00",
   "updated_by" : {
     "full_name" : "full_name",
@@ -540,7 +314,7 @@ Any modifications made to this file will be overwritten.
     
Responses

     
200

     Indicates a successful call.
-        
+        case_response_properties
@@ -620,6 +394,28 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, + "connector" : { + "name" : "none", + "id" : "none", + "fields" : { + "destIp" : "destIp", + "severity" : "severity", + "parent" : "parent", + "impact" : "impact", + "malwareUrl" : "malwareUrl", + "priority" : "priority", + "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], + "issueType" : "issueType", + "sourceIp" : "sourceIp", + "urgency" : "urgency", + "malwareHash" : "malwareHash", + "caseId" : "caseId", + "severityCode" : 6.027456183070403, + "category" : "category", + "subcategory" : "subcategory" + }, + "type" : ".none" + }, "updated_at" : "2000-01-23T04:56:07.000+00:00", "updated_by" : { "full_name" : "full_name", @@ -675,24 +471,12 @@ Any modifications made to this file will be overwritten.
  • alert_identifiers - Alert identifiers
  • alert_indices - Alert indices
  • case_response_closed_by_properties - Case response properties for closed_by
    • +
  • case_response_connector_field_properties - Case response properties for connector fields
  • case_response_created_by_properties - Case response properties for created_by
  • case_response_properties - Case response properties
  • case_response_pushed_by_properties - Case response properties for pushed_by
  • case_response_updated_by_properties - Case response properties for updated_by
    • -
  • connector_properties_cases_webhook - Create or upate case request properties for Cases Webhook connector
    • -
  • connector_properties_jira - Create or update case request properties for a Jira connector
    • -
  • connector_properties_jira_fields -
    • -
  • connector_properties_none - Create or update case request properties for no connector
    • -
  • connector_properties_resilient - Create case request properties for a IBM Resilient connector
    • -
  • connector_properties_resilient_fields -
    • -
  • connector_properties_servicenow - Create case request properties for a ServiceNow ITSM connector
    • -
  • connector_properties_servicenow_fields -
    • -
  • connector_properties_servicenow_sir - Create case request properties for a ServiceNow SecOps connector
    • -
  • connector_properties_servicenow_sir_fields -
    • -
  • connector_properties_swimlane - Create case request properties for a Swimlane connector
    • -
  • connector_properties_swimlane_fields -
    • -
  • create_case_request - Create case request
    • -
  • create_case_request_connector -
    • +
  • connector_types -
  • external_service -
  • owners -
  • rule - Alerting rule
    • @@ -701,8 +485,6 @@ Any modifications made to this file will be overwritten.
  • status -
  • update_alert_comment_request_properties - Update case comment request properties for alerts
  • update_case_comment_request - Update case comment request
    • -
  • update_case_request - Update case request
    • -
  • update_case_request_cases_inner -
  • update_user_comment_request_properties - Update case comment request properties for user comments
  • user_comment_response_properties - Case response properties for user comments
    • @@ -733,12 +515,10 @@ Any modifications made to this file will be overwritten.

    Case_response_properties_for_connectors - Case response properties for connectors Up

    -
    fields
    connector_properties_swimlane_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .swimlane
    +
    fields (optional)
    case_response_connector_field_properties
    +
    id (optional)
    String The identifier for the connector. To create a case without a connector, use none.
    +
    name (optional)
    String The name of the connector. To create a case without a connector, use none.
    +
    type (optional)
    connector_types
    @@ -850,6 +630,27 @@ Any modifications made to this file will be overwritten.
    profile_uid (optional)
    String
    +
    +

    case_response_connector_field_properties - Case response properties for connector fields Up

    +
    An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
    +
    +
    caseId (optional)
    String The case identifier for Swimlane connectors.
    +
    category (optional)
    String The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
    +
    destIp (optional)
    String A comma-separated list of destination IPs for ServiceNow SecOps connectors.
    +
    impact (optional)
    String The effect an incident had on business for ServiceNow ITSM connectors.
    +
    issueType (optional)
    String The type of issue for Jira connectors.
    +
    issueTypes (optional)
    array[BigDecimal] The type of incident for IBM Resilient connectors.
    +
    malwareHash (optional)
    String A comma-separated list of malware hashes for ServiceNow SecOps connectors.
    +
    malwareUrl (optional)
    String A comma-separated list of malware URLs for ServiceNow SecOps connectors.
    +
    parent (optional)
    String The key of the parent issue, when the issue type is sub-task for Jira connectors.
    +
    priority (optional)
    String The priority of the issue for Jira and ServiceNow SecOps connectors.
    +
    severity (optional)
    String The severity of the incident for ServiceNow ITSM connectors.
    +
    severityCode (optional)
    BigDecimal The severity code of the incident for IBM Resilient connectors.
    +
    sourceIp (optional)
    String A comma-separated list of source IPs for ServiceNow SecOps connectors.
    +
    subcategory (optional)
    String The subcategory of the incident for ServiceNow ITSM connectors.
    +
    urgency (optional)
    String The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
    +
    +

    case_response_created_by_properties - Case response properties for created_by Up

    @@ -908,161 +709,10 @@ Any modifications made to this file will be overwritten.
    -

    connector_properties_cases_webhook - Create or upate case request properties for Cases Webhook connector Up

    -
    Defines properties for connectors when type is .cases-webhook.
    -
    -
    fields
    String
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .cases-webhook
    -
    -
    -
    -

    connector_properties_jira - Create or update case request properties for a Jira connector Up

    -
    Defines properties for connectors when type is .jira.
    -
    -
    fields
    connector_properties_jira_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .jira
    -
    -
    -
    -

    connector_properties_jira_fields - Up

    -
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    -
    -
    issueType
    String The type of issue.
    -
    parent
    String The key of the parent issue, when the issue type is sub-task.
    -
    priority
    String The priority of the issue.
    -
    -
    -
    -

    connector_properties_none - Create or update case request properties for no connector Up

    -
    Defines properties for connectors when type is .none.
    +

    connector_types - Up

    +
    The type of connector.
    -
    fields
    String An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.
    -
    id
    String The identifier for the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.
    -
    name
    String The name of the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.
    -
    type
    String The type of connector. To create a case without a connector, use .none. To update a case to remove the connector, specify .none.
    -
    Enum:
    -
    .none
    -
    -
    -
    -

    connector_properties_resilient - Create case request properties for a IBM Resilient connector Up

    -
    Defines properties for connectors when type is .resilient.
    -
    -
    fields
    connector_properties_resilient_fields
    -
    id
    String The identifier for the connector.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .resilient
    -
    -
    -
    -

    connector_properties_resilient_fields - Up

    -
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    -
    -
    issueTypes
    array[String] The type of incident.
    -
    severityCode
    String The severity code of the incident.
    -
    -
    -
    -

    connector_properties_servicenow - Create case request properties for a ServiceNow ITSM connector Up

    -
    Defines properties for connectors when type is .servicenow.
    -
    -
    fields
    connector_properties_servicenow_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .servicenow
    -
    -
    -
    -

    connector_properties_servicenow_fields - Up

    -
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    -
    -
    category
    String The category of the incident.
    -
    impact
    String The effect an incident had on business.
    -
    severity
    String The severity of the incident.
    -
    subcategory
    String The subcategory of the incident.
    -
    urgency
    String The extent to which the incident resolution can be delayed.
    -
    -
    -
    -

    connector_properties_servicenow_sir - Create case request properties for a ServiceNow SecOps connector Up

    -
    Defines properties for connectors when type is .servicenow-sir.
    -
    -
    fields
    connector_properties_servicenow_sir_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .servicenow-sir
    -
    -
    -
    -

    connector_properties_servicenow_sir_fields - Up

    -
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    -
    -
    category
    String The category of the incident.
    -
    destIp
    Boolean Indicates whether cases will send a comma-separated list of destination IPs.
    -
    malwareHash
    Boolean Indicates whether cases will send a comma-separated list of malware hashes.
    -
    malwareUrl
    Boolean Indicates whether cases will send a comma-separated list of malware URLs.
    -
    priority
    String The priority of the issue.
    -
    sourceIp
    Boolean Indicates whether cases will send a comma-separated list of source IPs.
    -
    subcategory
    String The subcategory of the incident.
    -
    -
    -
    -

    connector_properties_swimlane - Create case request properties for a Swimlane connector Up

    -
    Defines properties for connectors when type is .swimlane.
    -
    -
    fields
    connector_properties_swimlane_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .swimlane
    -
    -
    -
    -

    connector_properties_swimlane_fields - Up

    -
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    -
    -
    caseId
    String The case identifier for Swimlane connectors.
    -
    -
    -
    -

    create_case_request - Create case request Up

    -
    The create case API request body varies depending on the type of connector.
    -
    -
    connector
    create_case_request_connector
    -
    description
    String The description for the case.
    -
    owner
    owners
    -
    settings
    settings
    -
    severity (optional)
    severity_property
    -
    tags
    array[String] The words and phrases that help categorize cases. It can be an empty array.
    -
    title
    String A title for the case.
    -
    -
    -
    -

    create_case_request_connector - Up

    -
    -
    -
    fields
    connector_properties_swimlane_fields
    -
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    -
    name
    String The name of the connector.
    -
    type
    String The type of connector.
    -
    Enum:
    -
    .swimlane
    -
    +

    external_service - Up

    @@ -1095,7 +745,7 @@ Any modifications made to this file will be overwritten.

    settings - Up

    An object that contains the case settings.
    -
    syncAlerts
    Boolean Turns alert syncing on or off.
    +
    syncAlerts (optional)
    Boolean Turns alert syncing on or off.
    @@ -1141,28 +791,6 @@ Any modifications made to this file will be overwritten.
    comment
    String The new comment. It is required only when type is user.
    -
    -

    update_case_request - Update case request Up

    -
    The update case API request body varies depending on the type of connector.
    -
    -
    cases
    array[update_case_request_cases_inner] An array containing one or more case objects.
    -
    -
    -
    -

    update_case_request_cases_inner - Up

    -
    -
    -
    connector (optional)
    create_case_request_connector
    -
    description (optional)
    String An updated description for the case.
    -
    id
    String The identifier for the case.
    -
    settings (optional)
    settings
    -
    severity (optional)
    severity_property
    -
    status (optional)
    status
    -
    tags (optional)
    array[String] The words and phrases that help categorize cases.
    -
    title (optional)
    String A title for the case.
    -
    version
    String The current version of the case. To determine this value, use the get case or find cases APIs.
    -
    -

    update_user_comment_request_properties - Update case comment request properties for user comments Up

    Defines properties for case comment requests when type is user.
    From 12b481a5a4e5367e1daf68c66094267f0a3d4288 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 18 Oct 2022 18:26:40 -0700 Subject: [PATCH 4/9] [DOCS] Update example for get case API --- docs/api/cases/cases-api-get-case.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/cases/cases-api-get-case.asciidoc b/docs/api/cases/cases-api-get-case.asciidoc index d7bc316a7346d..9d43afb695a79 100644 --- a/docs/api/cases/cases-api-get-case.asciidoc +++ b/docs/api/cases/cases-api-get-case.asciidoc @@ -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 } From c69786607f49ba82d5b340a10a4f3399b019568e Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 19 Oct 2022 08:17:52 -0700 Subject: [PATCH 5/9] [DOCS] Fixes nested objects --- docs/api/cases/cases-api-create.asciidoc | 5 +++-- docs/api/cases/cases-api-update.asciidoc | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc index de654903e10ef..c6c155adf4acb 100644 --- a/docs/api/cases/cases-api-create.asciidoc +++ b/docs/api/cases/cases-api-create.asciidoc @@ -35,8 +35,9 @@ default space is used. === {api-request-body-title} `assignees`:: -(Optional, array of objects) -.Properties of `assignees` objects +(Optional, array of objects) Array containing assignee objects. ++ +.Properties of assignee objects [%collapsible%open] ===== `uid`:: A user identifier to assign to the case. diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index 79b69c6769851..d790acc0df6ed 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -41,8 +41,8 @@ default space is used. [%collapsible%open] ==== `assignees`:: -(Optional, array of objects) -.Properties of `assignees` objects +(Optional, array of objects) Array containing assignee objects. +.Properties of assignee objects [%collapsible%open] ===== `uid`:: A user identifier to assign to the case. From 64aa400e5f7197f54a4a82d9ca249aad2428a150 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 19 Oct 2022 08:26:58 -0700 Subject: [PATCH 6/9] Re-generate API docs --- .../cases/case-apis-passthru.asciidoc | 606 +++++++++++++++--- 1 file changed, 511 insertions(+), 95 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 2a07283aa98e0..22bf195e3a80e 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -19,8 +19,11 @@ Any modifications made to this file will be overwritten.

    Cases

    @@ -84,6 +87,11 @@ Any modifications made to this file will be overwritten. "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", "comments" : [ null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", "title" : "Case title 1", @@ -102,28 +110,123 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, - "connector" : { - "name" : "none", - "id" : "none", - "fields" : { - "destIp" : "destIp", - "severity" : "severity", - "parent" : "parent", - "impact" : "impact", - "malwareUrl" : "malwareUrl", - "priority" : "priority", - "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], - "issueType" : "issueType", - "sourceIp" : "sourceIp", - "urgency" : "urgency", - "malwareHash" : "malwareHash", - "caseId" : "caseId", - "severityCode" : 6.027456183070403, - "category" : "category", - "subcategory" : "subcategory" + "updated_at" : "2000-01-23T04:56:07.000+00:00", + "updated_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" + }, + "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192", + "external_service" : { + "external_title" : "external_title", + "pushed_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" }, - "type" : ".none" + "external_url" : "external_url", + "pushed_at" : "2000-01-23T04:56:07.000+00:00", + "connector_id" : "connector_id", + "external_id" : "external_id", + "connector_name" : "connector_name" + } +}     + +

    Produces

    + This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
      +
    • application/json
      • +
    + +

    Responses

    +

    200

    + Indicates a successful call. + case_response_properties +
    +
    +
    +
    + Up + 
    post /s/{spaceId}/api/cases
    +
    Creates a case. (createCase)
    +
    You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case you're creating.
    + +

    Path parameters

    +
    +
    spaceId (required)
    + +
    Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
    +
    + +

    Consumes

    + This API call consumes the following media types via the Content-Type request header: +
      +
    • application/json
      • +
    + +

    Request body

    +
    +
    create_case_request create_case_request (required)
    + +
    Body Parameter —
    + +
    + +

    Request headers

    +
    +
    kbn-xsrf (required)
    + +
    Header Parameter — default: null
    + +
    + + + +

    Return type

    +
    + case_response_properties + +
    + + + +

    Example data

    +
    Content-Type: application/json
    + 
    {
+  "owner" : "cases",
+  "totalComment" : 0,
+  "settings" : {
+    "syncAlerts" : true
   },
+  "totalAlerts" : 0,
+  "closed_at" : "2000-01-23T04:56:07.000+00:00",
+  "comments" : [ null, null ],
+  "assignees" : [ {
+    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
+  }, {
+    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
+  } ],
+  "created_at" : "2022-05-13T09:16:17.416Z",
+  "description" : "A case description.",
+  "title" : "Case title 1",
+  "created_by" : {
+    "full_name" : "full_name",
+    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+    "email" : "email",
+    "username" : "elastic"
+  },
+  "version" : "WzUzMiwxXQ==",
+  "closed_by" : {
+    "full_name" : "full_name",
+    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+    "email" : "email",
+    "username" : "elastic"
+  },
+  "tags" : [ "tag-1" ],
+  "duration" : 120,
   "updated_at" : "2000-01-23T04:56:07.000+00:00",
   "updated_by" : {
     "full_name" : "full_name",
@@ -161,6 +264,49 @@ Any modifications made to this file will be overwritten.
         case_response_properties
    +
    +
    + Up + 
    delete /s/{spaceId}/api/cases
    +
    Deletes one or more cases. (deleteCase)
    +
    You must have read or all privileges and the delete sub-feature privilege for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
    + +

    Path parameters

    +
    +
    spaceId (required)
    + +
    Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
    +
    + + + +

    Request headers

    +
    +
    kbn-xsrf (required)
    + +
    Header Parameter — default: null
    + +
    + +

    Query parameters

    +
    +
    ids (required)
    + +
    Query Parameter — The cases that you want to removed. All non-ASCII characters must be URL encoded. default: null
    +
    + + + + + + + +

    Responses

    +

    204

    + Indicates a successful call. + +
    +
    Up @@ -240,6 +386,11 @@ Any modifications made to this file will be overwritten. "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", "comments" : [ null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", "title" : "Case title 1", @@ -258,28 +409,123 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, - "connector" : { - "name" : "none", - "id" : "none", - "fields" : { - "destIp" : "destIp", - "severity" : "severity", - "parent" : "parent", - "impact" : "impact", - "malwareUrl" : "malwareUrl", - "priority" : "priority", - "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], - "issueType" : "issueType", - "sourceIp" : "sourceIp", - "urgency" : "urgency", - "malwareHash" : "malwareHash", - "caseId" : "caseId", - "severityCode" : 6.027456183070403, - "category" : "category", - "subcategory" : "subcategory" + "updated_at" : "2000-01-23T04:56:07.000+00:00", + "updated_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" + }, + "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192", + "external_service" : { + "external_title" : "external_title", + "pushed_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" }, - "type" : ".none" + "external_url" : "external_url", + "pushed_at" : "2000-01-23T04:56:07.000+00:00", + "connector_id" : "connector_id", + "external_id" : "external_id", + "connector_name" : "connector_name" + } +} + +

    Produces

    + This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
      +
    • application/json
      • +
    + +

    Responses

    +

    200

    + Indicates a successful call. + case_response_properties +
    +
    +
    +
    + Up + 
    patch /s/{spaceId}/api/cases
    +
    Updates one or more cases. (updateCase)
    +
    You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case you're updating.
    + +

    Path parameters

    +
    +
    spaceId (required)
    + +
    Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
    +
    + +

    Consumes

    + This API call consumes the following media types via the Content-Type request header: +
      +
    • application/json
      • +
    + +

    Request body

    +
    +
    update_case_request update_case_request (optional)
    + +
    Body Parameter —
    + +
    + +

    Request headers

    +
    +
    kbn-xsrf (required)
    + +
    Header Parameter — default: null
    + +
    + + + +

    Return type

    +
    + array[case_response_properties] + +
    + + + +

    Example data

    +
    Content-Type: application/json
    + 
    {
+  "owner" : "cases",
+  "totalComment" : 0,
+  "settings" : {
+    "syncAlerts" : true
+  },
+  "totalAlerts" : 0,
+  "closed_at" : "2000-01-23T04:56:07.000+00:00",
+  "comments" : [ null, null ],
+  "assignees" : [ {
+    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
+  }, {
+    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
+  } ],
+  "created_at" : "2022-05-13T09:16:17.416Z",
+  "description" : "A case description.",
+  "title" : "Case title 1",
+  "created_by" : {
+    "full_name" : "full_name",
+    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+    "email" : "email",
+    "username" : "elastic"
   },
+  "version" : "WzUzMiwxXQ==",
+  "closed_by" : {
+    "full_name" : "full_name",
+    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+    "email" : "email",
+    "username" : "elastic"
+  },
+  "tags" : [ "tag-1" ],
+  "duration" : 120,
   "updated_at" : "2000-01-23T04:56:07.000+00:00",
   "updated_by" : {
     "full_name" : "full_name",
@@ -314,7 +560,7 @@ Any modifications made to this file will be overwritten.
     
    Responses
    
     
    200
    
     Indicates a successful call.
-        case_response_properties
+
    @@ -376,6 +622,11 @@ Any modifications made to this file will be overwritten. "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", "comments" : [ null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", "title" : "Case title 1", @@ -394,28 +645,6 @@ Any modifications made to this file will be overwritten. }, "tags" : [ "tag-1" ], "duration" : 120, - "connector" : { - "name" : "none", - "id" : "none", - "fields" : { - "destIp" : "destIp", - "severity" : "severity", - "parent" : "parent", - "impact" : "impact", - "malwareUrl" : "malwareUrl", - "priority" : "priority", - "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ], - "issueType" : "issueType", - "sourceIp" : "sourceIp", - "urgency" : "urgency", - "malwareHash" : "malwareHash", - "caseId" : "caseId", - "severityCode" : 6.027456183070403, - "category" : "category", - "subcategory" : "subcategory" - }, - "type" : ".none" - }, "updated_at" : "2000-01-23T04:56:07.000+00:00", "updated_by" : { "full_name" : "full_name", @@ -471,12 +700,26 @@ Any modifications made to this file will be overwritten.
  • alert_identifiers - Alert identifiers
  • alert_indices - Alert indices
  • case_response_closed_by_properties - Case response properties for closed_by
    • -
  • case_response_connector_field_properties - Case response properties for connector fields
  • case_response_created_by_properties - Case response properties for created_by
  • case_response_properties - Case response properties
    • +
  • case_response_properties_assignees_inner -
  • case_response_pushed_by_properties - Case response properties for pushed_by
  • case_response_updated_by_properties - Case response properties for updated_by
    • -
  • connector_types -
    • +
  • connector_properties_cases_webhook - Create or upate case request properties for Cases Webhook connector
    • +
  • connector_properties_jira - Create or update case request properties for a Jira connector
    • +
  • connector_properties_jira_fields -
    • +
  • connector_properties_none - Create or update case request properties for no connector
    • +
  • connector_properties_resilient - Create case request properties for a IBM Resilient connector
    • +
  • connector_properties_resilient_fields -
    • +
  • connector_properties_servicenow - Create case request properties for a ServiceNow ITSM connector
    • +
  • connector_properties_servicenow_fields -
    • +
  • connector_properties_servicenow_sir - Create case request properties for a ServiceNow SecOps connector
    • +
  • connector_properties_servicenow_sir_fields -
    • +
  • connector_properties_swimlane - Create case request properties for a Swimlane connector
    • +
  • connector_properties_swimlane_fields -
    • +
  • create_case_request - Create case request
    • +
  • create_case_request_assignees_inner -
    • +
  • create_case_request_connector -
  • external_service -
  • owners -
  • rule - Alerting rule
    • @@ -485,6 +728,8 @@ Any modifications made to this file will be overwritten.
  • status -
  • update_alert_comment_request_properties - Update case comment request properties for alerts
  • update_case_comment_request - Update case comment request
    • +
  • update_case_request - Update case request
    • +
  • update_case_request_cases_inner -
  • update_user_comment_request_properties - Update case comment request properties for user comments
  • user_comment_response_properties - Case response properties for user comments
    • @@ -515,10 +760,12 @@ Any modifications made to this file will be overwritten.

    Case_response_properties_for_connectors - Case response properties for connectors Up

    -
    fields (optional)
    case_response_connector_field_properties
    -
    id (optional)
    String The identifier for the connector. To create a case without a connector, use none.
    -
    name (optional)
    String The name of the connector. To create a case without a connector, use none.
    -
    type (optional)
    connector_types
    +
    fields
    connector_properties_swimlane_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .swimlane
    @@ -630,27 +877,6 @@ Any modifications made to this file will be overwritten.
    profile_uid (optional)
    String
    -
    -

    case_response_connector_field_properties - Case response properties for connector fields Up

    -
    An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
    -
    -
    caseId (optional)
    String The case identifier for Swimlane connectors.
    -
    category (optional)
    String The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
    -
    destIp (optional)
    String A comma-separated list of destination IPs for ServiceNow SecOps connectors.
    -
    impact (optional)
    String The effect an incident had on business for ServiceNow ITSM connectors.
    -
    issueType (optional)
    String The type of issue for Jira connectors.
    -
    issueTypes (optional)
    array[BigDecimal] The type of incident for IBM Resilient connectors.
    -
    malwareHash (optional)
    String A comma-separated list of malware hashes for ServiceNow SecOps connectors.
    -
    malwareUrl (optional)
    String A comma-separated list of malware URLs for ServiceNow SecOps connectors.
    -
    parent (optional)
    String The key of the parent issue, when the issue type is sub-task for Jira connectors.
    -
    priority (optional)
    String The priority of the issue for Jira and ServiceNow SecOps connectors.
    -
    severity (optional)
    String The severity of the incident for ServiceNow ITSM connectors.
    -
    severityCode (optional)
    BigDecimal The severity code of the incident for IBM Resilient connectors.
    -
    sourceIp (optional)
    String A comma-separated list of source IPs for ServiceNow SecOps connectors.
    -
    subcategory (optional)
    String The subcategory of the incident for ServiceNow ITSM connectors.
    -
    urgency (optional)
    String The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
    -
    -

    case_response_created_by_properties - Case response properties for created_by Up

    @@ -665,7 +891,8 @@ Any modifications made to this file will be overwritten.

    case_response_properties - Case response properties Up

    -
    closed_at
    Date format: date-time
    +
    assignees (optional)
    array[case_response_properties_assignees_inner]
    +
    closed_at
    Date format: date-time
    closed_by
    case_response_closed_by_properties
    comments
    array[Case_response_properties_for_comments_inner] An array of comment objects for the case.
    connector
    Case_response_properties_for_connectors
    @@ -688,6 +915,13 @@ Any modifications made to this file will be overwritten.
    version
    String
    +
    +

    case_response_properties_assignees_inner - Up

    +
    +
    +
    uid (optional)
    String
    +
    +

    case_response_pushed_by_properties - Case response properties for pushed_by Up

    @@ -709,10 +943,169 @@ Any modifications made to this file will be overwritten.
    -

    connector_types - Up

    -
    The type of connector.
    +

    connector_properties_cases_webhook - Create or upate case request properties for Cases Webhook connector Up

    +
    Defines properties for connectors when type is .cases-webhook.
    -
    +
    fields
    String
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .cases-webhook
    +
    + +
    +

    connector_properties_jira - Create or update case request properties for a Jira connector Up

    +
    Defines properties for connectors when type is .jira.
    +
    +
    fields
    connector_properties_jira_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .jira
    +
    +
    +
    +

    connector_properties_jira_fields - Up

    +
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    +
    +
    issueType
    String The type of issue.
    +
    parent
    String The key of the parent issue, when the issue type is sub-task.
    +
    priority
    String The priority of the issue.
    +
    +
    +
    +

    connector_properties_none - Create or update case request properties for no connector Up

    +
    Defines properties for connectors when type is .none.
    +
    +
    fields
    String An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.
    +
    id
    String The identifier for the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.
    +
    name
    String The name of the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.
    +
    type
    String The type of connector. To create a case without a connector, use .none. To update a case to remove the connector, specify .none.
    +
    Enum:
    +
    .none
    +
    +
    +
    +

    connector_properties_resilient - Create case request properties for a IBM Resilient connector Up

    +
    Defines properties for connectors when type is .resilient.
    +
    +
    fields
    connector_properties_resilient_fields
    +
    id
    String The identifier for the connector.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .resilient
    +
    +
    +
    +

    connector_properties_resilient_fields - Up

    +
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    +
    +
    issueTypes
    array[String] The type of incident.
    +
    severityCode
    String The severity code of the incident.
    +
    +
    +
    +

    connector_properties_servicenow - Create case request properties for a ServiceNow ITSM connector Up

    +
    Defines properties for connectors when type is .servicenow.
    +
    +
    fields
    connector_properties_servicenow_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .servicenow
    +
    +
    +
    +

    connector_properties_servicenow_fields - Up

    +
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    +
    +
    category
    String The category of the incident.
    +
    impact
    String The effect an incident had on business.
    +
    severity
    String The severity of the incident.
    +
    subcategory
    String The subcategory of the incident.
    +
    urgency
    String The extent to which the incident resolution can be delayed.
    +
    +
    +
    +

    connector_properties_servicenow_sir - Create case request properties for a ServiceNow SecOps connector Up

    +
    Defines properties for connectors when type is .servicenow-sir.
    +
    +
    fields
    connector_properties_servicenow_sir_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .servicenow-sir
    +
    +
    +
    +

    connector_properties_servicenow_sir_fields - Up

    +
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    +
    +
    category
    String The category of the incident.
    +
    destIp
    Boolean Indicates whether cases will send a comma-separated list of destination IPs.
    +
    malwareHash
    Boolean Indicates whether cases will send a comma-separated list of malware hashes.
    +
    malwareUrl
    Boolean Indicates whether cases will send a comma-separated list of malware URLs.
    +
    priority
    String The priority of the issue.
    +
    sourceIp
    Boolean Indicates whether cases will send a comma-separated list of source IPs.
    +
    subcategory
    String The subcategory of the incident.
    +
    +
    +
    +

    connector_properties_swimlane - Create case request properties for a Swimlane connector Up

    +
    Defines properties for connectors when type is .swimlane.
    +
    +
    fields
    connector_properties_swimlane_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .swimlane
    +
    +
    +
    +

    connector_properties_swimlane_fields - Up

    +
    An object containing the connector fields. If you want to omit any individual field, specify null as its value.
    +
    +
    caseId
    String The case identifier for Swimlane connectors.
    +
    +
    +
    +

    create_case_request - Create case request Up

    +
    The create case API request body varies depending on the type of connector.
    +
    +
    assignees (optional)
    array[create_case_request_assignees_inner]
    +
    connector
    create_case_request_connector
    +
    description
    String The description for the case.
    +
    owner
    owners
    +
    settings
    settings
    +
    severity (optional)
    severity_property
    +
    tags
    array[String] The words and phrases that help categorize cases. It can be an empty array.
    +
    title
    String A title for the case.
    +
    +
    +
    +

    create_case_request_assignees_inner - Up

    +
    +
    +
    uid (optional)
    String A user identifier to assign to the case.
    +
    +
    +
    +

    create_case_request_connector - Up

    +
    +
    +
    fields
    connector_properties_swimlane_fields
    +
    id
    String The identifier for the connector. To retrieve connector IDs, use the find connectors API.
    +
    name
    String The name of the connector.
    +
    type
    String The type of connector.
    +
    Enum:
    +
    .swimlane
    +

    external_service - Up

    @@ -745,7 +1138,7 @@ Any modifications made to this file will be overwritten.

    settings - Up

    An object that contains the case settings.
    -
    syncAlerts (optional)
    Boolean Turns alert syncing on or off.
    +
    syncAlerts
    Boolean Turns alert syncing on or off.
    @@ -791,6 +1184,29 @@ Any modifications made to this file will be overwritten.
    comment
    String The new comment. It is required only when type is user.
    +
    +

    update_case_request - Update case request Up

    +
    The update case API request body varies depending on the type of connector.
    +
    +
    cases
    array[update_case_request_cases_inner] An array containing one or more case objects.
    +
    +
    +
    +

    update_case_request_cases_inner - Up

    +
    +
    +
    assignees (optional)
    array[create_case_request_assignees_inner]
    +
    connector (optional)
    create_case_request_connector
    +
    description (optional)
    String An updated description for the case.
    +
    id
    String The identifier for the case.
    +
    settings (optional)
    settings
    +
    severity (optional)
    severity_property
    +
    status (optional)
    status
    +
    tags (optional)
    array[String] The words and phrases that help categorize cases.
    +
    title (optional)
    String A title for the case.
    +
    version
    String The current version of the case. To determine this value, use the get case or find cases APIs.
    +
    +

    update_user_comment_request_properties - Update case comment request properties for user comments Up

    Defines properties for case comment requests when type is user.
    From c49dd3bc7c445d147df769d5ee7f5ff3f8326f1f Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 19 Oct 2022 10:57:14 -0700 Subject: [PATCH 7/9] Fix formatting --- docs/api/cases/cases-api-update.asciidoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index d790acc0df6ed..58c07a5682c97 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -40,8 +40,10 @@ default space is used. .Properties of `cases` objects [%collapsible%open] ==== + `assignees`:: (Optional, array of objects) Array containing assignee objects. ++ .Properties of assignee objects [%collapsible%open] ===== From 662830dd8c00ae27461dc7b7cdf50dd6fe9727a6 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 19 Oct 2022 13:07:49 -0700 Subject: [PATCH 8/9] [DOCS] Add required property on uid --- docs/api-generated/cases/case-apis-passthru.asciidoc | 4 ++-- docs/api/cases/cases-api-create.asciidoc | 3 ++- docs/api/cases/cases-api-update.asciidoc | 3 ++- x-pack/plugins/cases/docs/openapi/bundled-min.json | 9 +++++++++ x-pack/plugins/cases/docs/openapi/bundled-min.yaml | 6 ++++++ .../components/schemas/case_response_properties.yaml | 2 ++ .../openapi/components/schemas/create_case_request.yaml | 2 ++ .../openapi/components/schemas/update_case_request.yaml | 2 ++ 8 files changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 22bf195e3a80e..41bec88086cfa 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -919,7 +919,7 @@ Any modifications made to this file will be overwritten.

    case_response_properties_assignees_inner - Up

    -
    uid (optional)
    String
    +
    uid
    String
    @@ -1092,7 +1092,7 @@ Any modifications made to this file will be overwritten.

    create_case_request_assignees_inner - Up

    -
    uid (optional)
    String A user identifier to assign to the case.
    +
    uid
    String A user identifier to assign to the case.
    diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc index c6c155adf4acb..4f83840c12366 100644 --- a/docs/api/cases/cases-api-create.asciidoc +++ b/docs/api/cases/cases-api-create.asciidoc @@ -40,7 +40,8 @@ default space is used. .Properties of assignee objects [%collapsible%open] ===== -`uid`:: A user identifier to assign to the case. +`uid`:: +(Required, string) A user identifier to assign to the case. // TBD How are these values found? ===== diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index 58c07a5682c97..598c738bd1875 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -47,7 +47,8 @@ default space is used. .Properties of assignee objects [%collapsible%open] ===== -`uid`:: A user identifier to assign to the case. +`uid`:: +(Required, string) A user identifier to assign to the case. // TBD How are these values found? ===== diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.json b/x-pack/plugins/cases/docs/openapi/bundled-min.json index ab93240249347..67c54958f105c 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.json +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.json @@ -821,6 +821,9 @@ "nullable": true, "items": { "type": "object", + "required": [ + "uid" + ], "properties": { "uid": { "type": "string", @@ -1291,6 +1294,9 @@ "nullable": true, "items": { "type": "object", + "required": [ + "uid" + ], "properties": { "uid": { "type": "string", @@ -1449,6 +1455,9 @@ "nullable": true, "items": { "type": "object", + "required": [ + "uid" + ], "properties": { "uid": { "type": "string", diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml index f4b35f119816b..d3adff2c31810 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml @@ -565,6 +565,8 @@ components: nullable: true items: type: object + required: + - uid properties: uid: type: string @@ -911,6 +913,8 @@ components: nullable: true items: type: object + required: + - uid properties: uid: type: string @@ -1016,6 +1020,8 @@ components: nullable: true items: type: object + required: + - uid properties: uid: type: string diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml index 90726528897ab..cb2e0d92a5efd 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml @@ -28,6 +28,8 @@ properties: nullable: true items: type: object + required: + - uid properties: uid: type: string diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml index 77c9c8e0500dd..4058cc388ed05 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml @@ -15,6 +15,8 @@ properties: nullable: true items: type: object + required: + - uid properties: uid: type: string diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml index bb137274ef7dc..b55395987e205 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml @@ -19,6 +19,8 @@ properties: nullable: true items: type: object + required: + - uid properties: uid: type: string From bb33f2329467aafd44fafbb3ca109ef1c91f527d Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 20 Oct 2022 09:59:14 -0700 Subject: [PATCH 9/9] [DOCS] Add user profile APIs to descriptions --- docs/api-generated/cases/case-apis-passthru.asciidoc | 10 +++++----- docs/api/cases/cases-api-create.asciidoc | 7 ++++--- docs/api/cases/cases-api-update.asciidoc | 7 ++++--- x-pack/plugins/cases/docs/openapi/bundled-min.json | 8 ++++++-- x-pack/plugins/cases/docs/openapi/bundled-min.yaml | 8 ++++++-- .../components/schemas/case_response_properties.yaml | 2 ++ .../components/schemas/create_case_request.yaml | 3 ++- .../components/schemas/update_case_request.yaml | 3 ++- 8 files changed, 31 insertions(+), 17 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 41bec88086cfa..2ccee8484b882 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -891,7 +891,7 @@ Any modifications made to this file will be overwritten.

    case_response_properties - Case response properties Up

    -
    assignees (optional)
    array[case_response_properties_assignees_inner]
    +
    assignees (optional)
    array[case_response_properties_assignees_inner] An array containing users that are assigned to the case.
    closed_at
    Date format: date-time
    closed_by
    case_response_closed_by_properties
    comments
    array[Case_response_properties_for_comments_inner] An array of comment objects for the case.
    @@ -919,7 +919,7 @@ Any modifications made to this file will be overwritten.

    case_response_properties_assignees_inner - Up

    -
    uid
    String
    +
    uid
    String A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
    @@ -1078,7 +1078,7 @@ Any modifications made to this file will be overwritten.

    create_case_request - Create case request Up

    The create case API request body varies depending on the type of connector.
    -
    assignees (optional)
    array[create_case_request_assignees_inner]
    +
    assignees (optional)
    array[create_case_request_assignees_inner] An array containing users that are assigned to the case.
    connector
    create_case_request_connector
    description
    String The description for the case.
    owner
    owners
    @@ -1092,7 +1092,7 @@ Any modifications made to this file will be overwritten.

    create_case_request_assignees_inner - Up

    -
    uid
    String A user identifier to assign to the case.
    +
    uid
    String A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
    @@ -1195,7 +1195,7 @@ Any modifications made to this file will be overwritten.

    update_case_request_cases_inner - Up

    -
    assignees (optional)
    array[create_case_request_assignees_inner]
    +
    assignees (optional)
    array[create_case_request_assignees_inner] An array containing users that are assigned to the case.
    connector (optional)
    create_case_request_connector
    description (optional)
    String An updated description for the case.
    id
    String The identifier for the case.
    diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc index 4f83840c12366..f124d3500228c 100644 --- a/docs/api/cases/cases-api-create.asciidoc +++ b/docs/api/cases/cases-api-create.asciidoc @@ -35,14 +35,15 @@ default space is used. === {api-request-body-title} `assignees`:: -(Optional, array of objects) Array containing assignee objects. +(Optional, array of objects) Array containing users that are assigned to the case. + .Properties of assignee objects [%collapsible%open] ===== `uid`:: -(Required, string) A user identifier to assign to the case. -// TBD How are these values found? +(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`:: diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index 598c738bd1875..ca75e34597afc 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -42,14 +42,15 @@ default space is used. ==== `assignees`:: -(Optional, array of objects) Array containing assignee objects. +(Optional, array of objects) Array containing users that are assigned to the case. + .Properties of assignee objects [%collapsible%open] ===== `uid`:: -(Required, string) A user identifier to assign to the case. -// TBD How are these values found? +(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`:: diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.json b/x-pack/plugins/cases/docs/openapi/bundled-min.json index 67c54958f105c..a3f9567b32b3d 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.json +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.json @@ -818,6 +818,7 @@ "properties": { "assignees": { "type": "array", + "description": "An array containing users that are assigned to the case.", "nullable": true, "items": { "type": "object", @@ -827,7 +828,7 @@ "properties": { "uid": { "type": "string", - "description": "A user identifier to assign to the case.", + "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" } } @@ -1291,6 +1292,7 @@ "properties": { "assignees": { "type": "array", + "description": "An array containing users that are assigned to the case.", "nullable": true, "items": { "type": "object", @@ -1300,6 +1302,7 @@ "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" } } @@ -1452,6 +1455,7 @@ "properties": { "assignees": { "type": "array", + "description": "An array containing users that are assigned to the case.", "nullable": true, "items": { "type": "object", @@ -1461,7 +1465,7 @@ "properties": { "uid": { "type": "string", - "description": "A user identifier to assign to the case.", + "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" } } diff --git a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml index d3adff2c31810..43962944ee9f7 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled-min.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled-min.yaml @@ -562,6 +562,7 @@ components: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -570,7 +571,7 @@ components: properties: uid: type: string - description: A user identifier to assign to the case. + 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: @@ -910,6 +911,7 @@ components: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -918,6 +920,7 @@ components: 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 @@ -1017,6 +1020,7 @@ components: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -1025,7 +1029,7 @@ components: properties: uid: type: string - description: A user identifier to assign to the case. + 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: diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml index cb2e0d92a5efd..1caa1643476d5 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml @@ -25,6 +25,7 @@ required: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -33,6 +34,7 @@ properties: 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 diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml index 4058cc388ed05..715bfaf112042 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml @@ -12,6 +12,7 @@ required: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -20,7 +21,7 @@ properties: properties: uid: type: string - description: A user identifier to assign to the case. + 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: diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml index b55395987e205..ee4249aeaf9d3 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/update_case_request.yaml @@ -16,6 +16,7 @@ properties: properties: assignees: type: array + description: An array containing users that are assigned to the case. nullable: true items: type: object @@ -24,7 +25,7 @@ properties: properties: uid: type: string - description: A user identifier to assign to the case. + 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: