[Cases] Update docs for remaining guardrails (elastic#162492)

## Summary Connected to elastic#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 <[email protected]>
ThomThomson · Aug 1, 2023 · 3ebff62 · 3ebff62
1 parent 1483ecf
commit 3ebff62
Show file tree

Hide file tree

Showing 10 changed files with 405 additions and 23 deletions.
diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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@[email protected] b/x-pack/plugins/cases/docs/openapi/paths/api@[email protected]
@@ -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@[email protected] b/x-pack/plugins/cases/docs/openapi/paths/api@[email protected]
@@ -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
@@ -29,6 +29,7 @@ get:
                 type: integer
               userActions:
                 type: array
+                maxItems: 10000
                 items:
                   $ref: '../components/schemas/user_actions_find_response_properties.yaml'
           examples: