[8.5] [DOCS] Automate final case APIs (#145007) (#145272)

x-pack/plugins/cases/docs/openapi/components/examples/get_case_activity_response.yaml

@@ -1,37 +1,72 @@
 summary: Retrieves all activity for a case
-value: 
-  [
-    {
-      "created_at":"2022-07-14T20:11:24.947Z",
-      "created_by":{"username":"elastic","email":null,"full_name":null},
-      "owner":"cases",
-      "action":"create",
-      "payload":{
-        "description":"A case description",
-        "title":"Case title 1",
-        "tags":["tag 1"],
-        "connector":{"name":"none","type":".none","fields":null,"id":"none"},
-        "settings":{"syncAlerts":true},
-        "owner":"cases",
-        "severity":"low",
-        "status":"open"
-      },
-      "type":"create_case",
-      "action_id":"22fd3e30-03b1-11ed-920c-974bfa104448",
-      "case_id":"22df07d0-03b1-11ed-920c-974bfa104448",
-      "comment_id":null
-    },
-    {
-      "created_at":"2022-07-14T20:12:53.354Z",
-      "created_by":{"username":"elastic","email":null,"full_name":null},
-      "owner":"cases",
-      "action":"create",
-      "payload":{
-        "comment":{"type":"user","owner":"cases","comment":"A new comment"}
-      },
-      "type":"comment",
-      "action_id":"57af14a0-03b1-11ed-920c-974bfa104448",
-      "case_id":"22df07d0-03b1-11ed-920c-974bfa104448",
-      "comment_id":"578608d0-03b1-11ed-920c-974bfa104448"
-    }
-  ]
+value:
+  - action_id: b4cd0770-07c9-11ed-a5fd-47154cb8767e
+    action: create
+    case_id: 22df07d0-03b1-11ed-920c-974bfa104448
+    comment_id: 578608d0-03b1-11ed-920c-974bfa104448
+    created_at: 2022-07-20T01:17:22.150Z
+    created_by:
+      username: elastic
+      email: null
+      full_name: null
+    owner: cases
+    payload:
+      assignees:
+      connector:
+        name: none
+        type: .none
+        fields: null
+        id: none
+      description: test
+      tags:
+        - mine
+      title: test-case
+      owner: cases
+      settings:
+        syncAlerts: false
+      severity: low
+      status: open 
+      type: create_case
+    type: comment
+  - action_id: 57af14a0-03b1-11ed-920c-974bfa104448
+    action: create
+    case_id: 22df07d0-03b1-11ed-920c-974bfa104448
+    comment_id: 578608d0-03b1-11ed-920c-974bfa104448
+    created_at: 2022-07-14T20:12:53.354Z
+    created_by:
+      username: elastic
+      email: null
+      full_name: null
+    owner: cases
+    payload:
+      comment: A new comment
+      owner: cases
+      type: user
+    type: comment
+  - action_id: 573c6980-6123-11ed-aa41-81a0a61fe447
+    action: add
+    case_id: 22df07d0-03b1-11ed-920c-974bfa104448
+    comment_id: null
+    created_at: 2022-07-20T01:10:28.238Z
+    created_by:
+      username: elastic
+      email: null
+      full_name: null
+      profile_uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
+    owner: cases
+    payload:
+      assignees:
+        uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
+    type: assignees
+  - action_id: fff460e0-07c9-11ed-a5fd-47154cb8767e
+    action: delete
+    case_id: 22df07d0-03b1-11ed-920c-974bfa104448
+    comment_id: null
+    created_at: 2022-07-20T01:19:28.238Z
+    created_by:
+      username: elastic
+      email: null
+      full_name: null
+    owner: cases
+    payload:
+    type: delete_case

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

x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml

@@ -11,17 +11,7 @@ created_at:
 created_by:
   type: object
   properties:
-    email:
-      type: string
-      example: null
-      nullable: true
-    full_name:
-      type: string
-      example: null
-      nullable: true
-    username: 
-      type: string
-      example: elastic
+    $ref: 'user_properties.yaml'
 error:
   type: string
   nullable: true
@@ -53,17 +43,7 @@ updated_at:
 updated_by:
   type: object
   properties:
-    email:
-      type: string
-      example: null
-      nullable: true
-    full_name:
-      type: string
-      example: null
-      nullable: true
-    username: 
-      type: string
-      example: elastic
+    $ref: 'user_properties.yaml'
   nullable: true
 version:
   type: string

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

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'

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'

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:

x-pack/plugins/cases/docs/openapi/components/schemas/payload_delete.yaml

@@ -0,0 +1,3 @@
+type: object
+description: If the `action` is `delete` and the `type` is `delete_case`, the payload is nullable.
+nullable: true

x-pack/plugins/cases/docs/openapi/components/schemas/payload_user_comment.yaml

@@ -10,4 +10,4 @@ properties:
       type:
         type: string
         enum:
-          - user      
+          - user

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'

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'
@@ -10,6 +20,7 @@ properties:
     example: 22df07d0-03b1-11ed-920c-974bfa104448
   comment_id:
     type: string
+    nullable: true
     example: 578608d0-03b1-11ed-920c-974bfa104448
   created_at:
     type: string
@@ -19,6 +30,10 @@ properties:
     type: object
     properties:
       $ref: 'user_properties.yaml'
+    required:
+      - email
+      - full_name
+      - username
   owner:
     $ref: 'owners.yaml'
   payload:
@@ -27,6 +42,7 @@ properties:
       - $ref: 'payload_assignees.yaml'
       - $ref: 'payload_connector.yaml'
       - $ref: 'payload_create_case.yaml'
+      - $ref: 'payload_delete.yaml'
       - $ref: 'payload_description.yaml'
       - $ref: 'payload_pushed.yaml'
       - $ref: 'payload_settings.yaml'
@@ -35,6 +51,5 @@ properties:
       - $ref: 'payload_tags.yaml'
       - $ref: 'payload_title.yaml'
       - $ref: 'payload_user_comment.yaml'
-    nullable: true
-  type: 
+  type:
     $ref: 'action_types.yaml'

x-pack/plugins/cases/docs/openapi/entrypoint-min.yaml

@@ -1,59 +0,0 @@
-openapi: 3.0.1
-info:
-  title: Cases
-  description: OpenAPI schema for Cases endpoints
-  version: '0.2'
-  contact:
-    name: Cases Team
-  license:
-    name: Elastic License 2.0
-    url: https://www.elastic.co/licensing/elastic-license
-tags:
-  - name: cases
-    description: Case APIs enable you to open and track issues.
-servers:
-  - url: 'http://localhost:5601'
-    description: local
-paths:
-  '/s/{spaceId}/api/cases':
-    $ref: 'paths/s@{spaceid}@api@cases.yaml'
-#  '/s/{spaceId}/api/cases/_find':
-#    $ref: 'paths/s@{spaceid}@api@cases@_find.yaml'
-  '/s/{spaceId}/api/cases/alerts/{alertId}':
-    $ref: 'paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml'
-  '/s/{spaceId}/api/cases/configure':
-    $ref: paths/s@{spaceid}@api@cases@configure.yaml
-  '/s/{spaceId}/api/cases/configure/{configurationId}':
-    $ref: paths/s@{spaceid}@api@cases@configure@{configurationid}.yaml
-#  '/s/{spaceId}/api/cases/configure/connectors/_find':
-#    $ref: paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
-  '/s/{spaceId}/api/cases/reporters':
-    $ref: 'paths/s@{spaceid}@api@cases@reporters.yaml'
-  '/s/{spaceId}/api/cases/status':
-    $ref: 'paths/s@{spaceid}@api@cases@status.yaml'
-  '/s/{spaceId}/api/cases/tags':
-    $ref: 'paths/s@{spaceid}@api@cases@tags.yaml'
-  '/s/{spaceId}/api/cases/{caseId}':
-    $ref: 'paths/s@{spaceid}@api@cases@{caseid}.yaml'
-#  '/s/{spaceId}/api/cases/{caseId}/alerts':
-#    $ref: 'paths/s@{spaceid}@api@cases@{caseid}@alerts.yaml'
-  '/s/{spaceId}/api/cases/{caseId}/comments':
-    $ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments.yaml'
-  '/s/{spaceId}/api/cases/{caseId}/comments/{commentId}':
-    $ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml'
-  '/s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push':
-    $ref: 'paths/s@{spaceid}@api@cases@{caseid}@connector@{connectorid}@_push.yaml'
-#  '/s/{spaceId}/api/cases/{caseId}/user_actions':
-#    $ref: 'paths/s@{spaceid}@api@cases@{caseid}@user_actions.yaml'
-components:
-  securitySchemes:
-    basicAuth:
-      type: http
-      scheme: basic
-    apiKeyAuth:
-      type: apiKey
-      in: header
-      name: ApiKey      
-security:
-  - basicAuth: []
-  - apiKeyAuth: []

x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml

@@ -131,7 +131,7 @@ get:
     '200':
       description: Indicates a successful call.
       content:
-         application/json; charset=utf-8:
+         application/json:
           schema:
             type: object
             properties:

x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml

@@ -13,7 +13,7 @@ get:
     '200':
       description: Indicates a successful call.
       content:
-        application/json; charset=utf-8:
+        application/json:
           schema:
             type: array
             items: 

x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@alerts.yaml

@@ -21,7 +21,7 @@ get:
             items:
               $ref: '../components/schemas/alert_response_properties.yaml'
           examples:
-            createCaseCommentResponse:
+            getCaseAlertsResponse:
               $ref: '../components/examples/get_case_alerts_response.yaml'
   servers:
     - url: https://localhost:5601

x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions.yaml

@@ -15,7 +15,7 @@ get:
     '200':
       description: Indicates a successful call.
       content:
-        application/json; charset=utf-8:
+        application/json:
           schema:
             type: array
             items: