Add operationId to cases openAPI specs (elastic#136161) (elastic#136298)

(cherry picked from commit 92a516a) Co-authored-by: Lisa Cawley <[email protected]>
jbudz · Jul 13, 2022 · 2efa79a · 2efa79a
1 parent 088e6fc
commit 2efa79a
Show file tree

Hide file tree

Showing 23 changed files with 163 additions and 52 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
@@ -19,7 +19,8 @@ servers:
 paths:
   /api/cases:
     post:
-      summary: Creates a case.
+      summary: Creates a case in the default space.
+      operationId: createCaseDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -411,7 +412,8 @@ paths:
       servers:
         - url: https://localhost:5601
     delete:
-      summary: Deletes one or more cases.
+      summary: Deletes one or more cases from the default space.
+      operationId: deleteCaseDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -436,7 +438,8 @@ paths:
       servers:
         - url: https://localhost:5601
     patch:
-      summary: Updates one or more cases.
+      summary: Updates one or more cases in the default space.
+      operationId: updateCaseDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -839,7 +842,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/_find:
     get:
-      summary: Retrieves a paginated subset of cases.
+      summary: Retrieves a paginated subset of cases from the default space.
+      operationId: getCasesDefaultSpace
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -1230,7 +1234,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/alerts/{alertId}:
     get:
-      summary: Returns the cases associated with a specific alert.
+      summary: Returns the cases associated with a specific alert in the default space.
+      operationId: getCasesByAlertDefaultSpace
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -1269,7 +1274,8 @@ paths:
     get:
       summary: >-
         Retrieves external connection details, such as the closure type and
-        default connector for cases.
+        default connector for cases in the default space.
+      operationId: getCaseConfigurationDefaultSpace
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -1455,7 +1461,8 @@ paths:
     post:
       summary: >-
         Sets external connection details, such as the closure type and default
-        connector for cases.
+        connector for cases in the default space.
+      operationId: setCaseConfigurationDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -1776,7 +1783,8 @@ paths:
     patch:
       summary: >-
         Updates external connection details, such as the closure type and
-        default connector for cases.
+        default connector for cases in the default space.
+      operationId: updateCaseConfigurationDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2086,7 +2094,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/configure/connectors/_find:
     get:
-      summary: Retrieves information about connectors.
+      summary: Retrieves information about connectors for cases in the default space.
+      operationId: getCaseConnectorsDefaultSpace
       description: >
         In particular, only the connectors that are supported for use in cases
         are  returned. You must have `read` privileges for the **Actions and
@@ -2136,7 +2145,10 @@ paths:
       - url: https://localhost:5601
   /api/cases/reporters:
     get:
-      summary: Returns information about the users who opened cases.
+      summary: >-
+        Returns information about the users who opened cases in the default
+        space.
+      operationId: getCaseReportersDefaultCase
       description: >
         You must have read privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2209,7 +2221,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/tags:
     get:
-      summary: Aggregates and returns a list of case tags.
+      summary: Aggregates and returns a list of case tags in the default space.
+      operationId: getCaseTagsDefaultSpace
       description: >
         You must have read privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2248,7 +2261,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/{caseId}/comments:
     post:
-      summary: Adds a comment or alert to a case.
+      summary: Adds a comment or alert to a case in the default space.
+      operationId: addCaseCommentDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2508,7 +2522,8 @@ paths:
       servers:
         - url: https://localhost:5601
     delete:
-      summary: Deletes all comments and alerts from a case.
+      summary: Deletes all comments and alerts from a case in the default space.
+      operationId: deleteCaseCommentsDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2525,7 +2540,8 @@ paths:
       servers:
         - url: https://localhost:5601
     patch:
-      summary: Updates a comment or alert in a case.
+      summary: Updates a comment or alert in a case in the default space.
+      operationId: updateCaseCommentDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2786,7 +2802,8 @@ paths:
       servers:
         - url: https://localhost:5601
     get:
-      summary: Retrieves all the comments from a case.
+      summary: Retrieves all the comments from a case in the default space.
+      operationId: getAllCaseCommentsDefaultSpace
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2816,7 +2833,8 @@ paths:
       - url: https://localhost:5601
   /api/cases/{caseId}/comments/{commentId}:
     delete:
-      summary: Deletes a comment or alert from a case.
+      summary: Deletes a comment or alert from a case in the default space.
+      operationId: deleteCaseCommentDefaultSpace
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2834,7 +2852,8 @@ paths:
       servers:
         - url: https://localhost:5601
     get:
-      summary: Retrieves a comment from a case.
+      summary: Retrieves a comment from a case in the default space.
+      operationId: getCaseCommentDefaultSpace
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -2865,6 +2884,7 @@ paths:
   /s/{spaceId}/api/cases:
     post:
       summary: Creates a case.
+      operationId: createCase
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the
@@ -3259,6 +3279,7 @@ paths:
         - url: https://localhost:5601
     delete:
       summary: Deletes one or more cases.
+      operationId: deleteCase
       description: >
         You must have `all` privileges for the **Cases** feature in the 
         **Management**, **Observability**, or **Security** section of the
@@ -3286,6 +3307,7 @@ paths:
         - url: https://localhost:5601
     patch:
       summary: Updates one or more cases.
+      operationId: updateCase
       description: >
         You must have `all` privileges for the **Cases** feature in the 
         **Management**, **Observability**, or **Security** section of the
@@ -3691,6 +3713,7 @@ paths:
   /s/{spaceId}/api/cases/_find:
     get:
       summary: Retrieves a paginated subset of cases.
+      operationId: getCases
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -4085,6 +4108,7 @@ paths:
   /s/{spaceId}/api/cases/alerts/{alertId}:
     get:
       summary: Returns the cases associated with a specific alert.
+      operationId: getCasesByAlert
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -4125,6 +4149,7 @@ paths:
       summary: >-
         Retrieves external connection details, such as the closure type and
         default connector for cases.
+      operationId: getCaseConfiguration
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -4312,6 +4337,7 @@ paths:
       summary: >-
         Sets external connection details, such as the closure type and default
         connector for cases.
+      operationId: setCaseConfiguration
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -4634,6 +4660,7 @@ paths:
       summary: >-
         Updates external connection details, such as the closure type and
         default connector for cases.
+      operationId: updateCaseConfiguration
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -4945,6 +4972,7 @@ paths:
   /s/{spaceId}/api/cases/configure/connectors/_find:
     get:
       summary: Retrieves information about connectors.
+      operationId: getCaseConnectors
       description: >
         In particular, only the connectors that are supported for use in cases
         are returned. You must have `read` privileges for the **Actions and
@@ -4997,6 +5025,7 @@ paths:
   /s/{spaceId}/api/cases/reporters:
     get:
       summary: Returns information about the users who opened cases.
+      operationId: getCaseReporters
       description: >
         You must have read privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5072,6 +5101,7 @@ paths:
   /s/{spaceId}/api/cases/tags:
     get:
       summary: Aggregates and returns a list of case tags.
+      operationId: getCaseTags
       description: >
         You must have read privileges for the **Cases*** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5112,6 +5142,7 @@ paths:
   /s/{spaceId}/api/cases/{caseId}/comments:
     post:
       summary: Adds a comment or alert to a case.
+      operationId: addCaseComment
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5373,6 +5404,7 @@ paths:
         - url: https://localhost:5601
     delete:
       summary: Deletes all comments and alerts from a case.
+      operationId: deleteCaseComments
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5391,6 +5423,7 @@ paths:
         - url: https://localhost:5601
     patch:
       summary: Updates a comment or alert in a case.
+      operationId: updateCaseComment
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5653,6 +5686,7 @@ paths:
         - url: https://localhost:5601
     get:
       summary: Retrieves all the comments from a case.
+      operationId: getAllCaseComments
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5684,6 +5718,7 @@ paths:
   /s/{spaceId}/api/cases/{caseId}/comments/{commentId}:
     delete:
       summary: Deletes a comment or alert from a case.
+      operationId: deleteCaseComment
       description: >
         You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the Kibana
@@ -5703,6 +5738,7 @@ paths:
         - url: https://localhost:5601
     get:
       summary: Retrieves a comment from a case.
+      operationId: getCaseComment
       description: >
         You must have `read` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security*** section of the

diff --git a/x-pack/plugins/cases/docs/openapi/components/examples/get_status.yaml b/x-pack/plugins/cases/docs/openapi/components/examples/get_status.yaml
@@ -0,0 +1,7 @@
+summary: Get the number of cases in each state.
+value: 
+  {
+    "count_open_cases": 27,
+    "count_in_progress_cases": 50,
+    "count_closed_cases": 198
+  }
diff --git a/x-pack/plugins/cases/docs/openapi/paths/[email protected] b/x-pack/plugins/cases/docs/openapi/paths/[email protected]
@@ -1,5 +1,6 @@
 post:
-  summary: Creates a case.
+  summary: Creates a case in the default space.
+  operationId: createCaseDefaultSpace
   description: >
     You must have `all` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana
@@ -73,7 +74,8 @@ post:
      - url: https://localhost:5601
 
 delete:
-  summary: Deletes one or more cases.
+  summary: Deletes one or more cases from the default space.
+  operationId: deleteCaseDefaultSpace
   description: >
     You must have `all` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana
@@ -97,7 +99,8 @@ delete:
     - url: https://localhost:5601
 
 patch:
-  summary: Updates one or more cases.
+  summary: Updates one or more cases in the default space.
+  operationId: updateCaseDefaultSpace
   description: >
     You must have `all` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml
@@ -1,5 +1,6 @@
 get:
-  summary: Retrieves a paginated subset of cases.
+  summary: Retrieves a paginated subset of cases from the default space.
+  operationId: getCasesDefaultSpace
   description: >
     You must have `read` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml
@@ -1,5 +1,6 @@
 get:
-  summary: Returns the cases associated with a specific alert.
+  summary: Returns the cases associated with a specific alert in the default space.
+  operationId: getCasesByAlertDefaultSpace
   description: >
     You must have `read` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@[email protected] b/x-pack/plugins/cases/docs/openapi/paths/api@[email protected]
@@ -1,5 +1,6 @@
 get:
-  summary: Retrieves external connection details, such as the closure type and default connector for cases.
+  summary: Retrieves external connection details, such as the closure type and default connector for cases in the default space.
+  operationId: getCaseConfigurationDefaultSpace
   description: >
     You must have `read` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana
@@ -24,7 +25,8 @@ get:
         - url: https://localhost:5601
 
 post:
-  summary: Sets external connection details, such as the closure type and default connector for cases.
+  summary: Sets external connection details, such as the closure type and default connector for cases in the default space.
+  operationId: setCaseConfigurationDefaultSpace
   description: >
     You must have `all` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@connectors@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@connectors@_find.yaml
@@ -1,5 +1,6 @@
 get:
-  summary: Retrieves information about connectors. 
+  summary: Retrieves information about connectors for cases in the default space.
+  operationId: getCaseConnectorsDefaultSpace
   description: >
     In particular, only the connectors that are supported for use in cases are 
     returned. You must have `read` privileges for the **Actions and Connectors**

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@{configurationid}.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@{configurationid}.yaml
@@ -1,5 +1,6 @@
 patch:
-  summary: Updates external connection details, such as the closure type and default connector for cases.
+  summary: Updates external connection details, such as the closure type and default connector for cases in the default space.
+  operationId: updateCaseConfigurationDefaultSpace
   description: >
     You must have `all` privileges for the **Cases** feature in the
     **Management**, **Observability**, or **Security** section of the Kibana