From 8287ce426d434a1397c7a5cdea1074991073053c Mon Sep 17 00:00:00 2001
From: Jan Monschke <jan.monschke@elastic.co>
Date: Wed, 3 Dec 2025 18:38:55 +0100
Subject: [PATCH] [Cases] Update delete case api example (#244878)

## Summary

The API expects an array, the example was a simple string

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit aea619e4f6b6d8b1b1e797867939cb94b0c8618e)
---
 oas_docs/output/kibana.yaml                     | 12 +++++++++++-
 .../shared/cases/docs/openapi/bundled.json      | 17 ++++++++++++++++-
 .../shared/cases/docs/openapi/bundled.yaml      | 12 +++++++++++-
 .../docs/openapi/components/parameters/ids.yaml |  2 +-
 4 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
index a89fc448c2701..7bcb6c6dc5a89 100644
--- a/oas_docs/output/kibana.yaml
+++ b/oas_docs/output/kibana.yaml
@@ -6948,6 +6948,7 @@ paths:
       operationId: getCaseDefaultSpace
       parameters:
         - $ref: '#/components/parameters/Cases_case_id'
+        - $ref: '#/components/parameters/Cases_includeComments'
       responses:
         '200':
           content:
@@ -63872,7 +63873,8 @@ components:
     Cases_ids:
       description: |
         The cases that you want to removed. All non-ASCII characters must be URL encoded.
-      example: d4e7abb0-b462-11ec-9a8d-698504725a43
+      example:
+        - d4e7abb0-b462-11ec-9a8d-698504725a43
       in: query
       name: ids
       required: true
@@ -63882,6 +63884,14 @@ components:
           minItems: 1
           type: string
         type: array
+    Cases_includeComments:
+      deprecated: true
+      description: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.
+      in: query
+      name: includeComments
+      schema:
+        default: true
+        type: boolean
     Cases_kbn_xsrf:
       description: Cross-site request forgery protection
       in: header
diff --git a/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.json b/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.json
index 88aaea6b72cdd..bbc787efa099b 100644
--- a/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.json
+++ b/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.json
@@ -1174,6 +1174,9 @@
         "parameters": [
           {
             "$ref": "#/components/parameters/case_id"
+          },
+          {
+            "$ref": "#/components/parameters/includeComments"
           }
         ],
         "responses": {
@@ -1821,7 +1824,9 @@
             "maxItems": 100
           }
         },
-        "example": "d4e7abb0-b462-11ec-9a8d-698504725a43"
+        "example": [
+          "d4e7abb0-b462-11ec-9a8d-698504725a43"
+        ]
       },
       "assignees_filter": {
         "in": "query",
@@ -2064,6 +2069,16 @@
           "example": "9c235210-6834-11ea-a78c-6ffb38a34414"
         }
       },
+      "includeComments": {
+        "in": "query",
+        "name": "includeComments",
+        "description": "Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.",
+        "deprecated": true,
+        "schema": {
+          "type": "boolean",
+          "default": true
+        }
+      },
       "comment_id": {
         "in": "path",
         "name": "commentId",
diff --git a/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.yaml b/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.yaml
index 0db46f3919ae3..d53f13358b876 100644
--- a/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.yaml
+++ b/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.yaml
@@ -789,6 +789,7 @@ paths:
         - cases
       parameters:
         - $ref: '#/components/parameters/case_id'
+        - $ref: '#/components/parameters/includeComments'
       responses:
         '200':
           description: Indicates a successful call.
@@ -1183,7 +1184,8 @@ components:
           type: string
           minItems: 1
           maxItems: 100
-      example: d4e7abb0-b462-11ec-9a8d-698504725a43
+      example:
+        - d4e7abb0-b462-11ec-9a8d-698504725a43
     assignees_filter:
       in: query
       name: assignees
@@ -1357,6 +1359,14 @@ components:
       schema:
         type: string
         example: 9c235210-6834-11ea-a78c-6ffb38a34414
+    includeComments:
+      in: query
+      name: includeComments
+      description: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.
+      deprecated: true
+      schema:
+        type: boolean
+        default: true
     comment_id:
       in: path
       name: commentId
diff --git a/x-pack/platform/plugins/shared/cases/docs/openapi/components/parameters/ids.yaml b/x-pack/platform/plugins/shared/cases/docs/openapi/components/parameters/ids.yaml
index c84ec64ab2a53..f357949cb62df 100644
--- a/x-pack/platform/plugins/shared/cases/docs/openapi/components/parameters/ids.yaml
+++ b/x-pack/platform/plugins/shared/cases/docs/openapi/components/parameters/ids.yaml
@@ -10,4 +10,4 @@ schema:
     type: string
     minItems: 1
     maxItems: 100
-example: d4e7abb0-b462-11ec-9a8d-698504725a43
+example: ["d4e7abb0-b462-11ec-9a8d-698504725a43"]