[8.11] [OAS] Migrate case APIs to v3.1.0 (#171593) (#171936)

# Backport

This will backport the following commits from `main` to `8.11`:
- [[OAS] Migrate case APIs to v3.1.0
(#171593)](https://github.com/elastic/kibana/pull/171593)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-11-24T17:08:34Z","message":"[OAS]
Migrate case APIs to v3.1.0
(#171593)","sha":"ea85f2a4796243d5856f6a369b5e96d1805fdda0","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","backport:prev-minor","v8.12.0"],"number":171593,"url":"https://github.com/elastic/kibana/pull/171593","mergeCommit":{"message":"[OAS]
Migrate case APIs to v3.1.0
(#171593)","sha":"ea85f2a4796243d5856f6a369b5e96d1805fdda0"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/171593","number":171593,"mergeCommit":{"message":"[OAS]
Migrate case APIs to v3.1.0
(#171593)","sha":"ea85f2a4796243d5856f6a369b5e96d1805fdda0"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

x-pack/plugins/cases/docs/openapi/components/parameters/alert_id.yaml

@@ -4,4 +4,5 @@ description: An identifier for the alert.
 required: true
 schema:
   type: string
-  example: 09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540
+  examples:
+    - 09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540

x-pack/plugins/cases/docs/openapi/components/parameters/case_id.yaml

@@ -4,4 +4,5 @@ description: The identifier for the case. To retrieve case IDs, use the find cas
 required: true
 schema:
   type: string
-  example: 9c235210-6834-11ea-a78c-6ffb38a34414
+  examples:
+    - 9c235210-6834-11ea-a78c-6ffb38a34414

x-pack/plugins/cases/docs/openapi/components/parameters/category.yaml

@@ -8,4 +8,5 @@ schema:
       items:
         type: string
       maxItems: 100
-example: my-category
+      examples:
+        - [ my-category ]

x-pack/plugins/cases/docs/openapi/components/parameters/comment_id.yaml

@@ -6,4 +6,5 @@ description: >
 required: true 
 schema:
   type: string
-  example: '71ec1870-725b-11ea-a0b2-c51ea50a58e2'
+  examples:
+    - '71ec1870-725b-11ea-a0b2-c51ea50a58e2'

x-pack/plugins/cases/docs/openapi/components/parameters/configuration_id.yaml

@@ -4,4 +4,5 @@ description: An identifier for the configuration.
 required: true
 schema:
   type: string
-  example: 3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9
+  examples:
+    - 3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9

x-pack/plugins/cases/docs/openapi/components/parameters/connector_id.yaml

@@ -4,4 +4,5 @@ description: An identifier for the connector. To retrieve connector IDs, use the
 required: true
 schema:
   type: string
-  example: abed3a70-71bd-11ea-a0b2-c51ea50a58e2
+  examples:
+    - abed3a70-71bd-11ea-a0b2-c51ea50a58e2

x-pack/plugins/cases/docs/openapi/components/parameters/defaultSearchOperator.yaml

@@ -4,4 +4,5 @@ description: he default operator to use for the simple_query_string.
 schema:
   type: string
   default: OR
-example: OR
+  examples:
+    - OR

x-pack/plugins/cases/docs/openapi/components/parameters/from.yaml

@@ -5,4 +5,5 @@ description: >
   The date must be specified as a KQL data range or date match expression.
 schema:
   type: string
-  example: now-1d
+  examples:
+    - now-1d

x-pack/plugins/cases/docs/openapi/components/parameters/ids.yaml

@@ -10,4 +10,5 @@ schema:
     type: string
     minItems: 1
     maxItems: 100
-example: d4e7abb0-b462-11ec-9a8d-698504725a43
+  examples:
+    - [ d4e7abb0-b462-11ec-9a8d-698504725a43 ]

x-pack/plugins/cases/docs/openapi/components/parameters/owner.yaml

@@ -10,4 +10,5 @@ schema:
     - type: array
       items:
         $ref: '../schemas/owners.yaml'
-example: cases
+      examples:
+        - [ cases ]

x-pack/plugins/cases/docs/openapi/components/parameters/page_index.yaml

@@ -5,3 +5,5 @@ required: false
 schema:
   type: integer
   default: 1
+  examples:
+    - 1

x-pack/plugins/cases/docs/openapi/components/parameters/reporters.yaml

@@ -8,4 +8,5 @@ schema:
       items:
         type: string
       maxItems: 100
-example: elastic
+      examples:
+        - [ elastic ]

x-pack/plugins/cases/docs/openapi/components/parameters/sortField.yaml

@@ -12,4 +12,5 @@ schema:
     - status
     - severity
   default: createdAt
-example: updatedAt
+  examples:
+    - updatedAt

x-pack/plugins/cases/docs/openapi/components/parameters/space_id.yaml

@@ -4,4 +4,5 @@ description: An identifier for the space. If `/s/` and the identifier are omitte
 required: true
 schema:
   type: string
-  example: default
+  examples:
+    - default

x-pack/plugins/cases/docs/openapi/components/parameters/status.yaml

@@ -7,4 +7,5 @@ schema:
     - closed
     - in-progress
     - open
-example: open
+  examples:
+    - open

x-pack/plugins/cases/docs/openapi/components/parameters/tags.yaml

@@ -8,4 +8,5 @@ schema:
       items:
         type: string
       maxItems: 100
-example: tag-1
+      examples:
+        - [ tag-1 ]

x-pack/plugins/cases/docs/openapi/components/parameters/to.yaml

@@ -5,4 +5,5 @@ description: >
   The date must be specified as a KQL data range or date match expression.
 schema:
   type: string
-example: now+1d
+  examples:
+    - now+1d

x-pack/plugins/cases/docs/openapi/components/parameters/user_action_types.yaml

@@ -21,4 +21,5 @@ schema:
       - tags
       - title
       - user
-example: create_case
+  examples:
+    - [ create_case ]

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

@@ -3,9 +3,11 @@ title: Unsuccessful cases API response
 properties:
   error:
     type: string
-    example: Unauthorized
+    examples:
+      - Unauthorized
   message:
     type: string 
   statusCode:
     type: integer
-    example: 401
+    examples:
+      - 401

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

@@ -13,4 +13,5 @@ enum:
   - status
   - settings
   - severity
-example: create_case
+examples:
+  - create_case

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

@@ -5,4 +5,5 @@ enum:
   - delete
   - push_to_service
   - update
-example: create
+examples:
+  - create

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

@@ -19,6 +19,7 @@ properties:
   type: 
     description: The type of comment.
     type: string
-    example: alert
+    examples:
+      - alert
     enum:
       - alert

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

@@ -6,13 +6,15 @@ properties:
     description: The new comment. It is required only when `type` is `user`.
     type: string
     maxLength: 30000
-    example: A new comment.
+    examples:
+      - A new comment.
   owner:
     $ref: 'owners.yaml'
   type: 
     type: string
     description: The type of comment.
-    example: user
+    examples:
+      - user
     enum:
       - user
 required:

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

@@ -7,11 +7,13 @@ properties:
     type: array
     items:
       type: string
-      example: a6e12ac4-7bce-457b-84f6-d7ce8deb8446
+      examples:
+        - a6e12ac4-7bce-457b-84f6-d7ce8deb8446
   created_at:
     type: string
     format: date-time
-    example: 2023-11-06T19:29:38.424Z
+    examples:
+      - 2023-11-06T19:29:38.424Z
   created_by:
     type: object
     required:
@@ -22,44 +24,52 @@ properties:
       $ref: 'user_properties.yaml'
   id:
     type: string
-    example: 73362370-ab1a-11ec-985f-97e55adae8b9
+    examples:
+      - 73362370-ab1a-11ec-985f-97e55adae8b9
   index:
     type: array
     items:
       type: string
-      example: .internal.alerts-security.alerts-default-000001
+      examples:
+        - .internal.alerts-security.alerts-default-000001
   owner:
     $ref: 'owners.yaml'
   pushed_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    example: null
-    nullable: true
+    examples:
+      - null
   pushed_by:
-    type: object
+    type:
+      - "object"
+      - "null"
     required:
       - email
       - full_name
       - username
     properties:
       $ref: 'user_properties.yaml'
-    nullable: true
   rule:
     type: object
     properties:
       $ref: 'rule_properties.yaml'
   type:
     type: string
-    example: alert
+    examples:
+      - alert
     enum:
       - alert
   updated_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    nullable: true
   updated_by:
-    type: object
-    nullable: true
+    type:
+      - "object"
+      - "null"
     required:
       - email
       - full_name
@@ -68,4 +78,5 @@ properties:
       $ref: 'user_properties.yaml'
   version:
     type: string
-    example: WzMwNDgsMV0=
+    examples:
+      - WzMwNDgsMV0=

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

@@ -13,4 +13,5 @@ oneOf:
       type: string
     maxItems: 1000
 x-technical-preview: true
-example: 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42
+examples:
+  - 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42

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

@@ -1,7 +1,8 @@
-type: array
+type:
+  - "array"
+  - "null"
 description: An array containing users that are assigned to the case.
 maxItems: 10
-nullable: true
 items:
   type: object
   required:
@@ -10,4 +11,5 @@ items:
     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
+      examples:
+        - u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0

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

@@ -1,14 +1,17 @@
 fields:
   description: The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to `null`.
-  nullable: true
-  type: object
+  type:
+    - "object"
+    - "null"
 id:
   description: The identifier for the connector. If you do not want a default connector, use `none`. To retrieve connector IDs, use the find connectors API.
   type: string
-  example: none
+  examples:
+    - none
 name:
   description: The name of the connector. If you do not want a default connector, use `none`. To retrieve connector names, use the find connectors API.
   type: string
-  example: none
+  examples:
+    - none
 type:
   $ref: 'connector_types.yaml'

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

@@ -15,7 +15,8 @@ connector:
 created_at:
   type: string
   format: date-time
-  example: 2022-06-01T17:07:17.767Z
+  examples:
+    - 2022-06-01T17:07:17.767Z
 created_by:
   type: object
   required:
@@ -25,12 +26,15 @@ created_by:
   properties:
     $ref: 'user_properties.yaml'
 error:
-  type: string
-  nullable: true
-  example: null
+  type:
+    - "string"
+    - "null"
+  examples:
+    - null
 id:
   type: string
-  example: 4a97a440-e1cd-11ec-be9b-9b1838238ee6
+  examples:
+    - 4a97a440-e1cd-11ec-be9b-9b1838238ee6
 mappings:
   type: array
   items:
@@ -38,29 +42,36 @@ mappings:
     properties:
       action_type:
         type: string
-        example: overwrite
+        examples:
+          - overwrite
       source:
         type: string
-        example: title
+        examples:
+          - title
       target:
         type: string
-        example: summary
+        examples:
+          - summary
 owner:
   $ref: 'owners.yaml'
 updated_at:
-  type: string
+  type:
+    - "string"
+    - "null"
   format: date-time
-  nullable: true
-  example: 2022-06-01T19:58:48.169Z
+  examples:
+    - 2022-06-01T19:58:48.169Z
 updated_by:
-  type: object
+  type:
+    - "object"
+    - "null"
   required:
       - email
       - full_name
       - username
   properties:
     $ref: 'user_properties.yaml'
-  nullable: true
 version:
   type: string
-  example: WzIwNzMsMV0=
+  examples:
+    - WzIwNzMsMV0=

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

@@ -18,8 +18,9 @@ value:
     However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is `undefined`.
     The value returned in the API and user interface in this case is `null`.
   oneOf:
-    - type: string
+    - type:
+      - "string"
+      - "null"
       minLength: 1
       maxLength: 160
-      nullable: true
     - type: boolean

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

@@ -1,6 +1,7 @@
 title: Case response properties for closed_by
-type: object
-nullable: true
+type:
+  - "object"
+  - "null"
 properties:
   $ref: 'user_properties.yaml'
 required:

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

@@ -1,7 +1,8 @@
 title: Case response properties for connector fields
-type: object
+type:
+  - "object"
+  - "null"
 description: An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
-nullable: true
 properties:
   caseId:
     description: The case identifier for Swimlane connectors.
@@ -11,8 +12,9 @@ properties:
     type: string
   destIp:
     description: Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.
-    type: boolean
-    nullable: true
+    type:
+      - "boolean"
+      - "null"
   impact:
     description: The effect an incident had on business for ServiceNow ITSM connectors.
     type: string
@@ -26,12 +28,14 @@ properties:
       type: string
   malwareHash:
     description: Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors. 
-    type: boolean
-    nullable: true
+    type:
+      - "boolean"
+      - "null"
   malwareUrl:
     description: Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors. 
-    type: boolean
-    nullable: true
+    type:
+      - "boolean"
+      - "null"
   parent:
     description: The key of the parent issue, when the issue type is sub-task for Jira connectors.
     type: string

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

@@ -26,13 +26,15 @@ properties:
   assignees:
     $ref: 'assignees.yaml'
   category:
-    type: string
+    type:
+      - "string"
+      - "null"
     description: The case category.
-    nullable: true
   closed_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    nullable: true
   closed_by:
     $ref: 'case_response_closed_by_properties.yaml'
   comments:
@@ -61,7 +63,8 @@ properties:
   created_at:
     type: string
     format: date-time
-    example: '2022-05-13T09:16:17.416Z'
+    examples:
+      - '2022-05-13T09:16:17.416Z'
   created_by:
     $ref: 'case_response_created_by_properties.yaml'
   customFields:
@@ -74,21 +77,25 @@ properties:
         $ref: 'case_customfields.yaml'
   description:
     type: string
-    example: A case description.
+    examples:
+      - A case description.
   duration:
-    type: integer
+    type:
+      - "integer"
+      - "null"
     description: >
       The elapsed time from the creation of the case to its closure (in seconds).
       If the case has not been closed, the duration is set to null. If the case
       was closed after less than half a second, the duration is rounded down to
       zero.
-    nullable: true
-    example: 120
+    examples:
+      - 120
   external_service:
     $ref: 'external_service.yaml'
   id:
     type: string
-    example: 66b9aa00-94fa-11ea-9f74-e7e108796192
+    examples:
+      - 66b9aa00-94fa-11ea-9f74-e7e108796192
   owner:
     $ref: 'owners.yaml'
   settings:
@@ -101,23 +108,28 @@ properties:
     type: array
     items:
       type: string
-    example:
-      - tag-1
+    examples:
+      - [tag-1]
   title:
     type: string
-    example: Case title 1
+    examples:
+      - Case title 1
   totalAlerts:
     type: integer
-    example: 0
+    examples:
+      - 0
   totalComment:
     type: integer
-    example: 0
+    examples:
+      - 0
   updated_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    nullable: true
   updated_by:
     $ref: 'case_response_updated_by_properties.yaml'
   version:
     type: string
-    example: WzUzMiwxXQ==
+    examples:
+      - WzUzMiwxXQ==

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

@@ -1,6 +1,7 @@
 title: Case response properties for pushed_by
-type: object
-nullable: true
+type:
+  - "object"
+  - "null"
 properties:
   $ref: 'user_properties.yaml'
 required:

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

@@ -1,6 +1,7 @@
 title: Case response properties for updated_by
-type: object
-nullable: true
+type:
+  - "object"
+  - "null"
 properties:
   $ref: 'user_properties.yaml'
 required:

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

@@ -3,4 +3,5 @@ description: Indicates whether a case is automatically closed when it is pushed
 enum:
   - close-by-pushing
   - close-by-user
-example: close-by-user
+examples:
+  - close-by-user

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

@@ -3,4 +3,5 @@ description: The type of comment.
 enum:
   - alert
   - user
-example: user
+examples:
+  - user

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

@@ -1,7 +1,11 @@
 fields:
-  description: An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
-  nullable: true
-  type: object
+  description: >
+    An object containing the connector fields.
+    To create a case without a connector, specify null.
+    If you want to omit any individual field, specify null as its value.
+  type:
+    - "object"
+    - "null"
   properties:
     caseId:
       description: The case identifier for Swimlane connectors.
@@ -11,8 +15,9 @@ fields:
       type: string
     destIp:
       description: Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.
-      type: boolean
-      nullable: true
+      type:
+        - "boolean"
+        - "null"
     impact:
       description: The effect an incident had on business for ServiceNow ITSM connectors.
       type: string
@@ -26,12 +31,14 @@ fields:
         type: string
     malwareHash:
       description: Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors. 
-      type: boolean
-      nullable: true
+      type:
+        - "boolean"
+        - "null"
     malwareUrl:
       description: Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors. 
-      type: boolean
-      nullable: true
+      type:
+        - "boolean"
+        - "null"
     parent:
       description: The key of the parent issue, when the issue type is sub-task for Jira connectors.
       type: string
@@ -46,22 +53,26 @@ fields:
       type: string
     sourceIp:
       description: Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors.
-      type: boolean
-      nullable: true
+      type:
+        - "boolean"
+        - "null"
     subcategory:
       description: The subcategory of the incident for ServiceNow ITSM connectors.
       type: string
     urgency:
       description: The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
       type: string
-  example: null
+  examples:
+    - null
 id:
   description: The identifier for the connector. To create a case without a connector, use `none`.
   type: string
-  example: none
+  examples:
+    - none
 name:
   description: The name of the connector. To create a case without a connector, use `none`.
   type: string
-  example: none
+  examples:
+    - none
 type:
   $ref: 'connector_types.yaml'

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

@@ -8,9 +8,11 @@ description: Defines properties for connectors when type is `.cases-webhook`.
 type: object
 properties:
   fields:
-    type: string
-    nullable: true
-    example: null  
+    type:
+      - "string"
+      - "null"
+    examples:
+      - null  
   id:
     description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
     type: string
@@ -20,6 +22,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .cases-webhook
+    examples:
+      - .cases-webhook
     enum:
       - .cases-webhook

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

@@ -17,16 +17,19 @@ properties:
     properties:
       issueType:
         description: The type of issue.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       parent:
         description: The key of the parent issue, when the issue type is sub-task.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       priority:
         description: The priority of the issue.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
   id:
     description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
     type: string
@@ -36,6 +39,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .jira
+    examples:
+      - .jira
     enum:
       - .jira

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

@@ -9,20 +9,25 @@ type: object
 properties:
   fields:
     description: An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.
-    nullable: true
-    type: string
-    example: null
+    type:
+      - "string"
+      - "null"
+    examples:
+      - null
   id:
     description: The identifier for the connector. To create a case without a connector, use `none`. To update a case to remove the connector, specify `none`.
     type: string
-    example: none
+    examples:
+      - none
   name:
     description: The name of the connector. To create a case without a connector, use `none`. To update a case to remove the connector, specify `none`.
     type: string
-    example: none
+    examples:
+      - none
   type: 
     description: The type of connector. To create a case without a connector, use `.none`. To update a case to remove the connector, specify `.none`.
     type: string
-    example: .none
+    examples:
+      - .none
     enum:
       - .none

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

@@ -9,8 +9,9 @@ type: object
 properties:
   fields:
     description: An object containing the connector fields. If you want to omit any individual field, specify null as its value.
-    type: object
-    nullable: true
+    type:
+      - "object"
+      - "null"
     required:
       - issueTypes
       - severityCode
@@ -32,6 +33,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .resilient
+    examples:
+      - .resilient
     enum:
       - .resilient

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

@@ -19,24 +19,29 @@ properties:
     properties:
       category:
         description: The category of the incident. 
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       impact:
         description: The effect an incident had on business.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       severity: 
         description: The severity of the incident.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       subcategory:
         description: The subcategory of the incident.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       urgency:
         description: The extent to which the incident resolution can be delayed.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
   id:
     description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
     type: string
@@ -46,6 +51,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .servicenow
+    examples:
+      - .servicenow
     enum:
       - .servicenow

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

@@ -21,32 +21,39 @@ properties:
     properties:
       category:
         description: The category of the incident. 
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       destIp:
         description: Indicates whether cases will send a comma-separated list of destination IPs.
-        type: boolean
-        nullable: true
+        type:
+          - "boolean"
+          - "null"
       malwareHash:
         description: Indicates whether cases will send a comma-separated list of malware hashes. 
-        type: boolean
-        nullable: true
+        type:
+          - "boolean"
+          - "null"
       malwareUrl:
         description: Indicates whether cases will send a comma-separated list of malware URLs. 
-        type: boolean
-        nullable: true
+        type:
+          - "boolean"
+          - "null"
       priority:
         description: The priority of the issue.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
       sourceIp:
         description: Indicates whether cases will send a comma-separated list of source IPs.
-        type: boolean
-        nullable: true
+        type:
+          - "boolean"
+          - "null"
       subcategory:
         description: The subcategory of the incident.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
   id:
     description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
     type: string
@@ -56,6 +63,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .servicenow-sir
+    examples:
+      - .servicenow-sir
     enum:
       - .servicenow-sir

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

@@ -15,8 +15,9 @@ properties:
     properties:
       caseId:
         description: The case identifier for Swimlane connectors.
-        type: string
-        nullable: true
+        type:
+          - "string"
+          - "null"
   id:
     description: The identifier for the connector. To retrieve connector IDs, use the find connectors API.
     type: string
@@ -26,6 +27,7 @@ properties:
   type:
     description: The type of connector.
     type: string
-    example: .swimlane
+    examples:
+      - .swimlane
     enum:
       - .swimlane

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

@@ -8,4 +8,5 @@ enum:
   - .servicenow
   - .servicenow-sir
   - .swimlane
-example: .none
+examples:
+  - .none

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

@@ -1,5 +1,6 @@
-type: object
-nullable: true
+type:
+  - "object"
+  - "null"
 properties:
   connector_id:
     type: string
@@ -15,7 +16,8 @@ properties:
     type: string
     format: date-time
   pushed_by:
-    type: object
+    type:
+      - "object"
+      - "null"
     properties:
-      $ref: 'user_properties.yaml'
-    nullable: true
+      $ref: 'user_properties.yaml'

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

@@ -6,4 +6,5 @@ enum:
   - cases
   - observability
   - securitySolution
-example: cases
+examples:
+  - cases

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

@@ -6,14 +6,16 @@ properties:
       alertId:
         oneOf:
           - type: string
-            example: 1c0b056b-cc9f-4b61-b5c9-cb801abd5e1d
+            examples:
+              - 1c0b056b-cc9f-4b61-b5c9-cb801abd5e1d
           - type: array
             items:
               type: string
       index:
         oneOf:
           - type: string
-            example: .alerts-observability.logs.alerts-default
+            examples:
+              - .alerts-observability.logs.alerts-default
           - type: array
             items:
               type: string

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

@@ -20,6 +20,7 @@ properties:
     type: array
     items:
       type: string
-      example: ["tag-1"]
+    examples:
+      - ["tag-1"]
   title:
     type: string

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

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

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

@@ -4,4 +4,5 @@ properties:
     type: array
     items:
       type: string
-    example: ["tag-1"]
+    examples:
+      - ["tag-1"]

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

@@ -10,8 +10,10 @@ properties:
   id:
     description: The rule identifier.
     type: string
-    example: 94d80550-aaf4-11ec-985f-97e55adae8b9
+    examples:
+      - 94d80550-aaf4-11ec-985f-97e55adae8b9
   name:
     description: The rule name.
     type: string
-    example: security_rule
+    examples:
+      - security_rule

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

@@ -1,8 +1,10 @@
 id:
   description: The rule identifier.
   type: string
-  example: 94d80550-aaf4-11ec-985f-97e55adae8b9
+  examples:
+    - 94d80550-aaf4-11ec-985f-97e55adae8b9
 name: 
   description: The rule name.
   type: string
-  example: security_rule
+  examples:
+    - security_rule

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

@@ -6,4 +6,5 @@ properties:
   syncAlerts:
     description: Turns alert syncing on or off.
     type: boolean
-    example: true
+    examples:
+      - true

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

@@ -17,7 +17,8 @@ properties:
     description: >
       The identifier for the comment. To retrieve comment IDs, use the
       get comments API.
-    example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
+    examples:
+      - 8af6ac20-74f6-11ea-b83a-553aecdb28b6
   index:
      $ref: 'alert_indices.yaml'
   owner:
@@ -29,10 +30,12 @@ properties:
     type: string
     enum:
      - alert
-    example: alert
+    examples:
+      - alert
   version:
     description: >
       The current comment version. To retrieve version values, use the get
       comments API.
     type: string
-    example: Wzk1LDFd
+    examples:
+      - Wzk1LDFd

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

@@ -34,4 +34,5 @@ properties:
       The version of the connector.
       To retrieve the version value, use the get configuration API.
     type: string
-    example: WzIwMiwxXQ==
+    examples:
+      - WzIwMiwxXQ==

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

@@ -6,13 +6,15 @@ properties:
     description: The new comment. It is required only when `type` is `user`.
     type: string
     maxLength: 30000
-    example: A new comment.
+    examples:
+      - A new comment.
   id:
     type: string
     description: >
       The identifier for the comment. To retrieve comment IDs, use the
       get comments API.
-    example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
+    examples:
+      - 8af6ac20-74f6-11ea-b83a-553aecdb28b6
   owner:
     $ref: 'owners.yaml'
   type: 
@@ -20,13 +22,15 @@ properties:
     description: The type of comment.
     enum:
       - user
-    example: user
+    examples:
+      - user
   version:
     description: >
       The current comment version. To retrieve version values, use the get
       comments API.
     type: string
-    example: Wzk1LDFd
+    examples:
+      - Wzk1LDFd
 required:
   - comment
   - id

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

@@ -13,13 +13,16 @@ properties:
   action:
     $ref: 'actions.yaml'
   comment_id:
-    type: string
-    nullable: true
-    example: 578608d0-03b1-11ed-920c-974bfa104448
+    type:
+      - "string"
+      - "null"
+    examples:
+      - 578608d0-03b1-11ed-920c-974bfa104448
   created_at:
     type: string
     format: date-time
-    example: 2022-05-13T09:16:17.416Z
+    examples:
+      - 2022-05-13T09:16:17.416Z
   created_by:
     type: object
     properties:
@@ -30,7 +33,8 @@ properties:
       - username
   id:
     type: string
-    example: 22fd3e30-03b1-11ed-920c-974bfa104448
+    examples:
+      - 22fd3e30-03b1-11ed-920c-974bfa104448
   owner:
     $ref: 'owners.yaml'
   payload:
@@ -50,7 +54,8 @@ properties:
       - $ref: 'payload_user_comment.yaml'
   version:
     type: string
-    example: WzM1ODg4LDFd
+    examples:
+      - WzM1ODg4LDFd
   type:
     type: string
     description: The type of action.
@@ -66,4 +71,5 @@ properties:
       - status
       - settings
       - severity
-    example: create_case
+    examples:
+      - create_case

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

@@ -14,18 +14,23 @@ properties:
     $ref: 'actions.yaml'
   action_id:
     type: string
-    example: 22fd3e30-03b1-11ed-920c-974bfa104448
+    examples:
+      - 22fd3e30-03b1-11ed-920c-974bfa104448
   case_id:
     type: string
-    example: 22df07d0-03b1-11ed-920c-974bfa104448
+    examples:
+      - 22df07d0-03b1-11ed-920c-974bfa104448
   comment_id:
-    type: string
-    nullable: true
-    example: 578608d0-03b1-11ed-920c-974bfa104448
+    type:
+      - "string"
+      - "null"
+    examples:
+      - 578608d0-03b1-11ed-920c-974bfa104448
   created_at:
     type: string
     format: date-time
-    example: 2022-05-13T09:16:17.416Z
+    examples:
+      - 2022-05-13T09:16:17.416Z
   created_by:
     type: object
     properties:

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

@@ -5,37 +5,46 @@ required:
 properties:
   comment:
     type: string
-    example: A new comment.
+    examples:
+      - A new comment.
   created_at:
     type: string
     format: date-time
-    example: 2022-05-13T09:16:17.416Z
+    examples:
+      - 2022-05-13T09:16:17.416Z
   created_by:
     $ref: 'case_response_created_by_properties.yaml'
   id:
     type: string
-    example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
+    examples:
+      - 8af6ac20-74f6-11ea-b83a-553aecdb28b6
   owner:
     $ref: 'owners.yaml'
   pushed_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    nullable: true
-    example: null
+    examples:
+      - null
   pushed_by:
     $ref: 'case_response_pushed_by_properties.yaml'
   type: 
     type: string
-    example: user
+    examples:
+      - user
     enum:
       - user
   updated_at:
-    type: string
+    type:
+      - "string"
+      - "null"
     format: date-time
-    nullable: true
-    example: null
+    examples:
+      - null
   updated_by:
     $ref: 'case_response_updated_by_properties.yaml'
   version:
     type: string
-    example: WzIwNDMxLDFd
+    examples:
+      - WzIwNDMxLDFd

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

@@ -1,15 +1,22 @@
 email:
-  type: string
-  example: null
-  nullable: true
+  type:
+    - "string"
+    - "null"
+  examples:
+    - null
 full_name:
-  type: string
-  example: null
-  nullable: true
-username:
-  type: string
-  example: elastic
-  nullable: true
+  type:
+    - "string"
+    - "null"
+  examples:
+    - null
 profile_uid:
   type: string
-  example: u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0
+  examples:
+    - u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0
+username:
+  type:
+    - "string"
+    - "null"
+  examples:
+    - elastic

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

@@ -1,8 +1,8 @@
-openapi: 3.0.1
+openapi: 3.1.0
 info:
   title: Cases
   description: OpenAPI schema for Cases endpoints
-  version: '0.1'
+  version: '0.2'
   contact:
     name: Cases Team
   license:

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

@@ -28,7 +28,7 @@ get:
                 title:
                   type: string
                   description: The case title.
-            example:
+            examples:
               - id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
                 title: security_case
     '401':

x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@connector@{connectorid}@_push.yaml

@@ -14,8 +14,9 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          nullable: true
+          type:
+            - "object"
+            - "null"
   responses:
     '200':
       description: Indicates a successful call.

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

@@ -28,7 +28,7 @@ get:
                 title:
                   type: string
                   description: The case title.
-            example:
+            examples:
               - id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
                 title: security_case
     '401':

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

@@ -18,8 +18,9 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          nullable: true
+          type:
+            - "object"
+            - "null"
   responses:
     '200':
       description: Indicates a successful call.

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

@@ -11,7 +11,6 @@ get:
     - $ref: '../components/parameters/case_id.yaml'
     - $ref: '../components/parameters/space_id.yaml'
     - $ref: '../components/parameters/page_index.yaml'
-      example: "1"
     - $ref: '../components/parameters/page_size.yaml'
     - $ref: '../components/parameters/sort_order.yaml'
     - $ref: '../components/parameters/user_action_types.yaml'