From 3ebff62d379e22b8e2e5ba125337299d8af3e51b Mon Sep 17 00:00:00 2001 From: Janki Salvi <117571355+js-jankisalvi@users.noreply.github.com> Date: Wed, 26 Jul 2023 12:29:38 +0200 Subject: [PATCH] [Cases] Update docs for remaining guardrails (#162492) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary Connected to https://github.com/elastic/kibana/issues/146945 This PR updates API docs for Description | Limit | Done? | Documented? | UI? -- | -- | -- | -- | -- Total assignees per case | 10 | ✅ | Yes | ✅ Maximum number of cases/user actions/comments returned from the API | 10.000 | ✅ | Yes | N/A Total number of cases by alert ID returned from the API | 10.000 | ✅ | Yes | N/A Total number of tags returned from the API | 10.000 | ✅ | Yes | N/A Total number of reporters returned from the API | 10.000 | ✅ | Yes | N/A ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: lcawl --- .../cases/case-apis-passthru.asciidoc | 407 +++++++++++++++++- .../plugins/cases/docs/openapi/bundled.json | 7 + .../plugins/cases/docs/openapi/bundled.yaml | 7 + .../openapi/components/schemas/assignees.yaml | 1 + .../schemas/case_response_properties.yaml | 1 + .../docs/openapi/paths/api@cases@_find.yaml | 1 + .../paths/api@cases@alerts@{alertid}.yaml | 1 + .../openapi/paths/api@cases@reporters.yaml | 1 + .../docs/openapi/paths/api@cases@tags.yaml | 1 + ...api@cases@{caseid}@user_actions@_find.yaml | 1 + 10 files changed, 405 insertions(+), 23 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 8970186559032..eb354b320d899 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -126,11 +126,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -246,11 +252,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -366,11 +378,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -480,11 +498,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -869,7 +893,7 @@ Any modifications made to this file will be overwritten.

Return type

- findCaseActivityDefaultSpace_200_response + findCaseActivity_200_response
@@ -922,7 +946,7 @@ Any modifications made to this file will be overwritten.

Responses

200

Indicates a successful call. - findCaseActivityDefaultSpace_200_response + findCaseActivity_200_response

401

Authorization information is missing or invalid. 4xx_response @@ -998,6 +1022,48 @@ Any modifications made to this file will be overwritten. "username" : "elastic" }, "version" : "WzM1ODg4LDFd" + }, { + "owner" : "cases", + "action" : "create", + "created_at" : "2022-05-13T09:16:17.416Z", + "id" : "22fd3e30-03b1-11ed-920c-974bfa104448", + "comment_id" : "578608d0-03b1-11ed-920c-974bfa104448", + "type" : "create_case", + "created_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" + }, + "version" : "WzM1ODg4LDFd" + }, { + "owner" : "cases", + "action" : "create", + "created_at" : "2022-05-13T09:16:17.416Z", + "id" : "22fd3e30-03b1-11ed-920c-974bfa104448", + "comment_id" : "578608d0-03b1-11ed-920c-974bfa104448", + "type" : "create_case", + "created_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" + }, + "version" : "WzM1ODg4LDFd" + }, { + "owner" : "cases", + "action" : "create", + "created_at" : "2022-05-13T09:16:17.416Z", + "id" : "22fd3e30-03b1-11ed-920c-974bfa104448", + "comment_id" : "578608d0-03b1-11ed-920c-974bfa104448", + "type" : "create_case", + "created_by" : { + "full_name" : "full_name", + "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0", + "email" : "email", + "username" : "elastic" + }, + "version" : "WzM1ODg4LDFd" } ], "total" : 1, "perPage" : 6, @@ -1069,11 +1135,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1302,7 +1374,7 @@ Any modifications made to this file will be overwritten.

Return type

- findCasesDefaultSpace_200_response + findCases_200_response
@@ -1322,11 +1394,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1376,11 +1454,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1438,7 +1522,7 @@ Any modifications made to this file will be overwritten.

Responses

200

Indicates a successful call. - findCasesDefaultSpace_200_response + findCases_200_response

401

Authorization information is missing or invalid. 4xx_response @@ -1515,11 +1599,137 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "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", + "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" + }, + "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" + } + }, { + "owner" : "cases", + "totalComment" : 0, + "settings" : { + "syncAlerts" : true + }, + "totalAlerts" : 0, + "closed_at" : "2000-01-23T04:56:07.000+00:00", + "comments" : [ null, null, null, null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "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", + "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" + }, + "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" + } + }, { + "owner" : "cases", + "totalComment" : 0, + "settings" : { + "syncAlerts" : true + }, + "totalAlerts" : 0, + "closed_at" : "2000-01-23T04:56:07.000+00:00", + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1569,11 +1779,77 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "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", + "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" + }, + "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" + } + }, { + "owner" : "cases", + "totalComment" : 0, + "settings" : { + "syncAlerts" : true + }, + "totalAlerts" : 0, + "closed_at" : "2000-01-23T04:56:07.000+00:00", + "comments" : [ null, null, null, null, null ], + "assignees" : [ { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1676,11 +1952,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1777,11 +2059,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -1886,11 +2174,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -2491,11 +2785,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -3047,11 +3347,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -3169,11 +3475,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -3485,11 +3797,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -3607,11 +3925,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -3727,11 +4051,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -4045,11 +4375,17 @@ Any modifications made to this file will be overwritten. }, "totalAlerts" : 0, "closed_at" : "2000-01-23T04:56:07.000+00:00", - "comments" : [ null, null ], + "comments" : [ null, null, null, null, null ], "assignees" : [ { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" }, { "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" + }, { + "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0" } ], "created_at" : "2022-05-13T09:16:17.416Z", "description" : "A case description.", @@ -4152,12 +4488,14 @@ Any modifications made to this file will be overwritten.
  • create_case_request_connector -
  • external_service -
  • findCaseActivityDefaultSpace_200_response -
    • +
  • findCaseActivity_200_response -
  • findCaseConnectorsDefaultSpace_200_response_inner -
  • findCaseConnectorsDefaultSpace_200_response_inner_config -
  • findCasesDefaultSpace_200_response -
  • findCasesDefaultSpace_assignees_parameter -
  • findCasesDefaultSpace_owner_parameter -
  • findCasesDefaultSpace_searchFields_parameter -
    • +
  • findCases_200_response -
  • getCaseCommentDefaultSpace_200_response -
  • getCaseConfigurationDefaultSpace_200_response_inner -
  • getCaseConfigurationDefaultSpace_200_response_inner_connector -
    • @@ -4615,6 +4953,16 @@ Any modifications made to this file will be overwritten.
    page (optional)
    Integer
    perPage (optional)
    Integer
    total (optional)
    Integer
    +
    userActions (optional)
    array[user_actions_find_response_properties]
    + + +
    +

    findCaseActivity_200_response - Up

    +
    +
    +
    page (optional)
    Integer
    +
    perPage (optional)
    Integer
    +
    total (optional)
    Integer
    userActions (optional)
    array[user_actions_find_response_properties]
    @@ -4671,6 +5019,19 @@ Any modifications made to this file will be overwritten.
    +
    +

    findCases_200_response - Up

    +
    +
    +
    cases (optional)
    array[case_response_properties]
    +
    count_closed_cases (optional)
    Integer
    +
    count_in_progress_cases (optional)
    Integer
    +
    count_open_cases (optional)
    Integer
    +
    page (optional)
    Integer
    +
    per_page (optional)
    Integer
    +
    total (optional)
    Integer
    +
    +

    getCaseCommentDefaultSpace_200_response - Up

    diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json index 3ff6564699cf6..2aed6ef9f65f3 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.json +++ b/x-pack/plugins/cases/docs/openapi/bundled.json @@ -266,6 +266,7 @@ "properties": { "cases": { "type": "array", + "maxItems": 10000, "items": { "$ref": "#/components/schemas/case_response_properties" } @@ -345,6 +346,7 @@ "application/json": { "schema": { "type": "array", + "maxItems": 10000, "items": { "type": "object", "properties": { @@ -954,6 +956,7 @@ "application/json": { "schema": { "type": "array", + "maxItems": 10000, "items": { "type": "object", "properties": { @@ -1094,6 +1097,7 @@ "application/json": { "schema": { "type": "array", + "maxItems": 10000, "items": { "type": "string" } @@ -1719,6 +1723,7 @@ }, "userActions": { "type": "array", + "maxItems": 10000, "items": { "$ref": "#/components/schemas/user_actions_find_response_properties" } @@ -4157,6 +4162,7 @@ "assignees": { "type": "array", "description": "An array containing users that are assigned to the case.", + "maxItems": 10, "nullable": true, "items": { "type": "object", @@ -5069,6 +5075,7 @@ "title": "Case response properties for comments", "description": "An array of comment objects for the case.", "type": "array", + "maxItems": 10000, "items": { "discriminator": { "propertyName": "type" diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml index be8e2da0462e8..6c2bd225ced70 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled.yaml @@ -150,6 +150,7 @@ paths: properties: cases: type: array + maxItems: 10000 items: $ref: '#/components/schemas/case_response_properties' count_closed_cases: @@ -196,6 +197,7 @@ paths: application/json: schema: type: array + maxItems: 10000 items: type: object properties: @@ -610,6 +612,7 @@ paths: application/json: schema: type: array + maxItems: 10000 items: type: object properties: @@ -696,6 +699,7 @@ paths: application/json: schema: type: array + maxItems: 10000 items: type: string examples: @@ -1054,6 +1058,7 @@ paths: type: integer userActions: type: array + maxItems: 10000 items: $ref: '#/components/schemas/user_actions_find_response_properties' examples: @@ -2565,6 +2570,7 @@ components: assignees: type: array description: An array containing users that are assigned to the case. + maxItems: 10 nullable: true items: type: object @@ -3254,6 +3260,7 @@ components: title: Case response properties for comments description: An array of comment objects for the case. type: array + maxItems: 10000 items: discriminator: propertyName: type diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml index 97f7dc115b215..5b4e18517bd43 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml @@ -1,5 +1,6 @@ type: array description: An array containing users that are assigned to the case. +maxItems: 10 nullable: true items: type: object 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 e20bfe664221a..cda4361ab4cc4 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 @@ -35,6 +35,7 @@ properties: title: Case response properties for comments description: An array of comment objects for the case. type: array + maxItems: 10000 items: discriminator: propertyName: type diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml index 2dc92988f9d32..6fd7f65ced3ad 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml @@ -34,6 +34,7 @@ get: properties: cases: type: array + maxItems: 10000 items: $ref: '../components/schemas/case_response_properties.yaml' count_closed_cases: diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml index 8ce27543da072..24e91369a6422 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml @@ -18,6 +18,7 @@ get: application/json: schema: type: array + maxItems: 10000 items: type: object properties: diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml index 2410b238ed284..7bf256e3c33a3 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml @@ -16,6 +16,7 @@ get: application/json: schema: type: array + maxItems: 10000 items: type: object properties: diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml index e456816163baf..3ce4e0578178e 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml @@ -14,6 +14,7 @@ get: application/json: schema: type: array + maxItems: 10000 items: type: string examples: diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@user_actions@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@user_actions@_find.yaml index dea4c6facfd64..ab8c16a641fdc 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@user_actions@_find.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@user_actions@_find.yaml @@ -29,6 +29,7 @@ get: type: integer userActions: type: array + maxItems: 10000 items: $ref: '../components/schemas/user_actions_find_response_properties.yaml' examples: