[DOCS] Add missing assignees to payload

elastic · Nov 10, 2022 · b88aa39 · b88aa39
1 parent b67df81
commit b88aa39
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 180 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
@@ -1939,6 +1939,24 @@
       }
     },
     "schemas": {
+      "assignees": {
+        "type": "array",
+        "description": "An array containing users that are assigned to the case.",
+        "nullable": true,
+        "items": {
+          "type": "object",
+          "required": [
+            "uid"
+          ],
+          "properties": {
+            "uid": {
+              "type": "string",
+              "description": "A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.",
+              "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
+            }
+          }
+        }
+      },
       "connector_properties_none": {
         "title": "Create or update case request properties for no connector",
         "required": [
@@ -2354,22 +2372,7 @@
         ],
         "properties": {
           "assignees": {
-            "type": "array",
-            "description": "An array containing users that are assigned to the case.",
-            "nullable": true,
-            "items": {
-              "type": "object",
-              "required": [
-                "uid"
-              ],
-              "properties": {
-                "uid": {
-                  "type": "string",
-                  "description": "A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.",
-                  "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
-                }
-              }
-            }
+            "$ref": "#/components/schemas/assignees"
           },
           "connector": {
             "oneOf": [
@@ -2828,22 +2831,7 @@
         ],
         "properties": {
           "assignees": {
-            "type": "array",
-            "description": "An array containing users that are assigned to the case.",
-            "nullable": true,
-            "items": {
-              "type": "object",
-              "required": [
-                "uid"
-              ],
-              "properties": {
-                "uid": {
-                  "type": "string",
-                  "description": "A unique identifier for the user profile. You can use the get user profile API to retrieve more details.",
-                  "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
-                }
-              }
-            }
+            "$ref": "#/components/schemas/assignees"
           },
           "closed_at": {
             "type": "string",
@@ -2991,22 +2979,7 @@
               ],
               "properties": {
                 "assignees": {
-                  "type": "array",
-                  "description": "An array containing users that are assigned to the case.",
-                  "nullable": true,
-                  "items": {
-                    "type": "object",
-                    "required": [
-                      "uid"
-                    ],
-                    "properties": {
-                      "uid": {
-                        "type": "string",
-                        "description": "A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.",
-                        "example": "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/assignees"
                 },
                 "connector": {
                   "oneOf": [
@@ -3416,15 +3389,7 @@
         "type": "object",
         "properties": {
           "assignees": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "uid": {
-                  "type": "string"
-                }
-              }
-            }
+            "$ref": "#/components/schemas/assignees"
           }
         }
       },
@@ -3529,6 +3494,9 @@
       "payload_create_case": {
         "type": "object",
         "properties": {
+          "assignees": {
+            "$ref": "#/components/schemas/assignees"
+          },
           "connector": {
             "type": "object",
             "properties": {
@@ -3761,6 +3729,17 @@
       },
       "user_actions_response_properties": {
         "type": "object",
+        "required": [
+          "action",
+          "action_id",
+          "case_id",
+          "comment_id",
+          "created_at",
+          "created_by",
+          "owner",
+          "payload",
+          "type"
+        ],
         "properties": {
           "action": {
             "$ref": "#/components/schemas/actions"

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
@@ -1217,6 +1217,19 @@ components:
         type: string
         example: abed3a70-71bd-11ea-a0b2-c51ea50a58e2
   schemas:
+    assignees:
+      type: array
+      description: An array containing users that are assigned to the case.
+      nullable: true
+      items:
+        type: object
+        required:
+          - uid
+        properties:
+          uid:
+            type: string
+            description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
+            example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
     connector_properties_none:
       title: Create or update case request properties for no connector
       required:
@@ -1539,18 +1552,7 @@ components:
         - title
       properties:
         assignees:
-          type: array
-          description: An array containing users that are assigned to the case.
-          nullable: true
-          items:
-            type: object
-            required:
-              - uid
-            properties:
-              uid:
-                type: string
-                description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
-                example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+          $ref: '#/components/schemas/assignees'
         connector:
           oneOf:
             - $ref: '#/components/schemas/connector_properties_none'
@@ -1888,18 +1890,7 @@ components:
         - version
       properties:
         assignees:
-          type: array
-          description: An array containing users that are assigned to the case.
-          nullable: true
-          items:
-            type: object
-            required:
-              - uid
-            properties:
-              uid:
-                type: string
-                description: A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
-                example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+          $ref: '#/components/schemas/assignees'
         closed_at:
           type: string
           format: date-time
@@ -1997,18 +1988,7 @@ components:
               - version
             properties:
               assignees:
-                type: array
-                description: An array containing users that are assigned to the case.
-                nullable: true
-                items:
-                  type: object
-                  required:
-                    - uid
-                  properties:
-                    uid:
-                      type: string
-                      description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
-                      example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+                $ref: '#/components/schemas/assignees'
               connector:
                 oneOf:
                   - $ref: '#/components/schemas/connector_properties_none'
@@ -2290,12 +2270,7 @@ components:
       type: object
       properties:
         assignees:
-          type: array
-          items:
-            type: object
-            properties:
-              uid:
-                type: string
+          $ref: '#/components/schemas/assignees'
     payload_connector:
       type: object
       properties:
@@ -2372,6 +2347,8 @@ components:
     payload_create_case:
       type: object
       properties:
+        assignees:
+          $ref: '#/components/schemas/assignees'
         connector:
           type: object
           properties:
@@ -2536,6 +2513,16 @@ components:
       example: create_case
     user_actions_response_properties:
       type: object
+      required:
+        - action
+        - action_id
+        - case_id
+        - comment_id
+        - created_at
+        - created_by
+        - owner
+        - payload
+        - type
       properties:
         action:
           $ref: '#/components/schemas/actions'

diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/assignees.yaml
@@ -0,0 +1,12 @@
+type: array
+description: An array containing users that are assigned to the case.
+nullable: true
+items:
+  type: object
+  required:
+    - uid
+  properties:
+    uid:
+      type: string
+      description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
+      example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
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
@@ -24,18 +24,7 @@ required:
   - version
 properties:
   assignees:
-    type: array
-    description: An array containing users that are assigned to the case.
-    nullable: true
-    items:
-      type: object
-      required:
-        - uid
-      properties:
-        uid:
-          type: string
-          description: A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
-          example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+    $ref: 'assignees.yaml'
   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
@@ -11,18 +11,7 @@ required:
       - title
 properties:
   assignees:
-    type: array
-    description: An array containing users that are assigned to the case.
-    nullable: true
-    items:
-      type: object
-      required:
-        - uid
-      properties:
-        uid:
-          type: string
-          description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
-          example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+    $ref: 'assignees.yaml'
   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
@@ -1,9 +1,4 @@
 type: object
 properties:
   assignees:
-    type: array
-    items:
-      type: object
-      properties:
-        uid:
-          type: string
+    $ref: 'assignees.yaml'
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml
@@ -1,5 +1,7 @@
 type: object
 properties:
+  assignees:
+    $ref: 'assignees.yaml'
   connector: 
     type: object
     properties:

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
@@ -15,18 +15,7 @@ properties:
         - version
       properties:
         assignees:
-          type: array
-          description: An array containing users that are assigned to the case.
-          nullable: true
-          items:
-            type: object
-            required:
-             - uid
-            properties:
-              uid:
-                type: string
-                description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
-                example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
+          $ref: 'assignees.yaml'
         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
@@ -1,4 +1,14 @@
 type: object
+required:
+  - action
+  - action_id
+  - case_id
+  - comment_id
+  - created_at
+  - created_by
+  - owner
+  - payload
+  - type
 properties:
   action:
     $ref: 'actions.yaml'