[OAS][Cases] Add case templates to case configuration APIs (elastic#1…

…87613)
kapral18 · Jul 8, 2024 · 35ee0cc · 35ee0cc
1 parent 94cab93
commit 35ee0cc
Show file tree

Hide file tree

Showing 35 changed files with 1,367 additions and 630 deletions.
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/get_case_configuration_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/get_case_configuration_response.yaml
@@ -4,11 +4,12 @@ value:
     closure_type: close-by-user
     customFields:
       - key: d312efda-ec2b-42ec-9e2c-84981795c581
+        defaultValue: Custom text field value.
         label: my-text-field
         required: false
         type: text
     owner: cases
-    created_at: 2023-06-01T17:07:17.767Z
+    created_at: 2024-07-01T17:07:17.767Z
     created_by:
       username: elastic
       email: null
@@ -21,5 +22,30 @@ value:
       type: .none
       fields: null
     mappings: []
-    version: WzUxLDRd
+    version: WzEyLDNd
     error: null
+    templates:
+      - key: 505932fe-ee3a-4960-a661-c781b5acdb05
+        name: template-1
+        caseFields:
+          title: Default case title
+          tags:
+            - Default case tag
+          category: Default-category
+          description: A default description for cases.
+          assignees:
+            - uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
+          connector:
+            id: none
+            type: .none
+            fields: null
+            name: none
+          customFields:
+            - key: d312efda-ec2b-42ec-9e2c-84981795c581
+              value: Default text field value.
+              type: text
+          settings:
+            syncAlerts: false
+        description: A description of the template.
+        tags:
+          - Template tag 1
diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/set_case_configuration_request.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/set_case_configuration_request.yaml
@@ -1,4 +1,4 @@
-summary: Set the closure type and default connector for Stack Management cases.
+summary: Set the closure type, custom fields, and default connector for Stack Management cases.
 value: 
   owner: cases
   connector:
@@ -11,4 +11,23 @@ value:
     - key: d312efda-ec2b-42ec-9e2c-84981795c581
       label: my-text-field
       required: false
-      type: text
+      type: text
+      defaultValue: My custom field default value.
+  templates:
+    - key: 505932fe-ee3a-4960-a661-c781b5acdb05
+      name: template-1
+      caseFields: 
+        title: Default case title
+        tags:
+          - Default case tag
+        category: Default-category
+        description: A default description for cases.
+        assignees:
+          - uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
+        customFields:
+          - key: d312efda-ec2b-42ec-9e2c-84981795c581
+            type: text
+            value: A text field value for the template.
+      description: A description of the template.
+      tags:
+        - Template tag 1       
diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/set_case_configuration_response.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/set_case_configuration_response.yaml
@@ -6,8 +6,27 @@ value:
       label: my-text-field
       required: false
       type: text
+      defaultValue: My custom field default value.
+  templates:
+    - key: 505932fe-ee3a-4960-a661-c781b5acdb05
+      name: template-1
+      caseFields: 
+        title: Default case title
+        tags:
+          - Default case tag
+        category: Default-category
+        description: A default description for cases.
+        assignees:
+          - uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
+        customFields:
+          - key: d312efda-ec2b-42ec-9e2c-84981795c581
+            type: text
+            value: A text field value for the template.
+      description: A description of the template.
+      tags:
+        - Template tag 1
   owner: cases
-  created_at: 2023-10-01T17:07:17.767Z
+  created_at: 2024-07-01T17:07:17.767Z
   created_by:
     username: elastic
     email: null,
@@ -30,6 +49,9 @@ value:
     - source: comments
       target: comments
       action_type: append
+    - source: tags
+      target: labels
+      action_type: overwrite
   version: WzIwNzMsMV0=
   error: null
   id: 4a97a440-e1cd-11ec-be9b-9b1838238ee6
diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/update_case_configuration_request.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/update_case_configuration_request.yaml
@@ -12,6 +12,7 @@ value:
       label: my-text-field
       required: true
       type: text
+      defaultValue: "A new default value."
     - key: fcc6840d-eb14-42df-8aaf-232201a705ec
       label: my-toggle
       required: false

diff --git a/...ck/plugins/cases/docs/openapi/components/examples/update_case_configuration_response.yaml b/...ck/plugins/cases/docs/openapi/components/examples/update_case_configuration_response.yaml
@@ -6,18 +6,19 @@ value:
       label: my-text-field
       required: true
       type: text
+      defaultValue: A new default value.
     - key: fcc6840d-eb14-42df-8aaf-232201a705ec
       label: my-toggle
       required: false
       type: toggle
   owner: cases
-  created_at: 2023-10-01T17:07:17.767Z
+  created_at: 2024-07-01T17:07:17.767Z
   created_by:
     username: elastic
-    email: null,
+    email: null
     full_name: null
     profile_uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
-  updated_at: 2023-10-19T00:52:42.401Z
+  updated_at: 2024-07-19T00:52:42.401Z
   updated_by:
     username: elastic
     full_name: null
@@ -35,9 +36,13 @@ value:
     - source: description
       target: description
       action_type: overwrite
+    - source: tags
+      target: labels
+      action_type: overwrite
     - source: comments
       target: comments
       action_type: append
-  version: zEzNSw1XQ==
+  version: WzI2LDNd
   error: null
-  id: 4a97a440-e1cd-11ec-be9b-9b1838238ee6
+  id: 4a97a440-e1cd-11ec-be9b-9b1838238ee6
+  templates: []
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_category.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_category.yaml
@@ -0,0 +1,3 @@
+description: A word or phrase that categorizes the case.
+type: string
+maxLength: 50
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_customfields.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_customfields.yaml
@@ -1,3 +1,11 @@
+defaultValue:
+  oneOf:
+    - type: string
+    - type: boolean
+  description: >
+    A default value for the custom field.
+    If the `type` is `text`, the default value must be a string.
+    If the `type` is `toggle`, the default value must be boolean.
 key:
   description: >
     A unique key for the custom field.

diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml
@@ -1,13 +1,5 @@
 closure_type:
   $ref: 'closure_types.yaml'
-customFields:
-  type: array
-  x-technical-preview: true
-  description: Custom fields configuration details.
-  items:
-    type: object
-    properties:
-      $ref: 'case_configure_customfields.yaml'
 connector: 
   type: object
   properties:
@@ -25,6 +17,14 @@ created_by:
       - username
   properties:
     $ref: 'user_properties.yaml'
+customFields:
+  type: array
+  x-technical-preview: true
+  description: Custom fields configuration details.
+  items:
+    type: object
+    properties:
+      $ref: 'case_configure_customfields.yaml'
 error:
   type:
     - "string"
@@ -54,6 +54,8 @@ mappings:
           - summary
 owner:
   $ref: 'owners.yaml'
+templates:
+  $ref: 'templates.yaml'
 updated_at:
   type:
     - "string"

diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_description.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_description.yaml
@@ -0,0 +1,3 @@
+description: The description for the case.
+type: string
+maxLength: 30000
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
@@ -112,9 +112,9 @@ properties:
   settings:
     $ref: 'settings.yaml'
   severity:
-    $ref: 'severity_property.yaml'
+    $ref: 'case_severity.yaml'
   status:
-    $ref: 'status.yaml'
+    $ref: 'case_status.yaml'
   tags:
     type: array
     items:

diff --git a/...components/schemas/severity_property.yaml → ...api/components/schemas/case_severity.yaml b/...components/schemas/severity_property.yaml → ...api/components/schemas/case_severity.yaml
diff --git a/...cs/openapi/components/schemas/status.yaml → ...enapi/components/schemas/case_status.yaml b/...cs/openapi/components/schemas/status.yaml → ...enapi/components/schemas/case_status.yaml
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_tags.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_tags.yaml
@@ -0,0 +1,7 @@
+description: >
+  The words and phrases that help categorize cases. It can be an empty array.
+type: array
+maxItems: 200
+items:
+  type: string
+  maxLength: 256
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_title.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_title.yaml
@@ -0,0 +1,3 @@
+description: A title for the case.
+type: string
+maxLength: 160
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
@@ -22,30 +22,19 @@ properties:
       - $ref: 'connector_properties_servicenow_sir.yaml'
       - $ref: 'connector_properties_swimlane.yaml'
   description:
-    description: The description for the case.
-    type: string
-    maxLength: 30000
+    $ref: 'case_description.yaml'
   owner:
     $ref: 'owners.yaml'
   settings:
     $ref: 'settings.yaml'
   severity:
-    $ref: 'severity_property.yaml'
+    $ref: 'case_severity.yaml'
   tags:
-    description: The words and phrases that help categorize cases. It can be an empty array.
-    type: array
-    maxItems: 200
-    items:
-      type: string
-      maxLength: 256
+    $ref: 'case_tags.yaml'
   category:
-    description: A word or phrase that categorizes the case.
-    type: string
-    maxLength: 50
+    $ref: 'case_category.yaml'
   title:
-    description: A title for the case.
-    type: string
-    maxLength: 160
+    $ref: 'case_title.yaml'
   customFields:
     type: array
     description: >

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
@@ -13,9 +13,9 @@ properties:
   settings:
     $ref: 'settings.yaml'
   severity:
-    $ref: 'severity_property.yaml'
+    $ref: 'case_severity.yaml'
   status: 
-    $ref: 'status.yaml'
+    $ref: 'case_status.yaml'
   tags: 
     type: array
     items:

diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_severity.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_severity.yaml
@@ -1,4 +1,4 @@
 type: object
 properties:
   severity:
-    $ref: 'severity_property.yaml'
+    $ref: 'case_severity.yaml'
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_status.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_status.yaml
@@ -1,4 +1,4 @@
 type: object
 properties:
   status:
-    $ref: 'status.yaml'
+    $ref: 'case_status.yaml'
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml
@@ -35,3 +35,5 @@ properties:
         $ref: 'case_configure_customfields.yaml'
   owner:
     $ref: 'owners.yaml'
+  templates:
+    $ref: 'templates.yaml'
diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/template_tags.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/template_tags.yaml
@@ -0,0 +1,7 @@
+description: >
+  The words and phrases that help categorize templates. It can be an empty array.
+type: array
+maxItems: 200
+items:
+  type: string
+  maxLength: 256