Add more operation summaries

elastic · Jun 8, 2022 · 1c10dc5 · 1c10dc5
1 parent 2018b15
commit 1c10dc5
Show file tree

Hide file tree

Showing 9 changed files with 75 additions and 66 deletions.
diff --git a/docs/api/cases/cases-api-add-comment.asciidoc b/docs/api/cases/cases-api-add-comment.asciidoc
@@ -4,7 +4,7 @@
 <titleabbrev>Add comment</titleabbrev>
 ++++
 
-Adds a comment to a case.
+Adds a comment or alert to a case.
 
 === {api-request-title}
 

diff --git a/docs/api/cases/cases-api-delete-comments.asciidoc b/docs/api/cases/cases-api-delete-comments.asciidoc
@@ -4,7 +4,7 @@
 <titleabbrev>Delete comments</titleabbrev>
 ++++
 
-Deletes one or all comments from a case.
+Deletes one or all comments and alerts from a case.
 
 === {api-request-title}
 

diff --git a/docs/api/cases/cases-api-update-comment.asciidoc b/docs/api/cases/cases-api-update-comment.asciidoc
@@ -4,7 +4,7 @@
 <titleabbrev>Update comment</titleabbrev>
 ++++
 
-Updates a comment in a case.
+Updates a comment or alert in a case.
 
 === {api-request-title}
 

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json
@@ -2437,8 +2437,8 @@
     },
     "/api/cases/{caseId}/comments": {
       "post": {
-        "summary": "Adds a comment to a case.",
-        "description": "Adds a comment to a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
+        "summary": "Adds a comment or alert to a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
         "tags": [
           "cases",
           "kibana"
@@ -2763,7 +2763,8 @@
         ]
       },
       "delete": {
-        "description": "Deletes one or all comments from a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
+        "summary": "Deletes all comments and alerts from a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
         "tags": [
           "cases",
           "kibana"
@@ -2788,7 +2789,8 @@
         ]
       },
       "patch": {
-        "description": "Updates a comment in a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
+        "summary": "Updates a comment or alert in a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
         "tags": [
           "cases",
           "kibana"
@@ -5548,7 +5550,8 @@
     },
     "/s/{spaceId}/api/cases/{caseId}/comments": {
       "post": {
-        "description": "Adds a comment to a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
+        "summary": "Adds a comment or alert to a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
         "tags": [
           "cases",
           "kibana"
@@ -5876,7 +5879,8 @@
         ]
       },
       "delete": {
-        "description": "Deletes one or all comments from a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
+        "summary": "Deletes all comments and alerts from a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
         "tags": [
           "cases",
           "kibana"
@@ -5904,7 +5908,8 @@
         ]
       },
       "patch": {
-        "description": "Updates a comment in a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
+        "summary": "Updates a comment or alert in a case.",
+        "description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
         "tags": [
           "cases",
           "kibana"

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
@@ -2082,12 +2082,11 @@ paths:
       - url: https://localhost:5601
   /api/cases/{caseId}/comments:
     post:
-      summary: Adds a comment to a case.
+      summary: Adds a comment or alert to a case.
       description: >
-        Adds a comment to a case. You must have all privileges for the **Cases**
-        feature in the **Management**, **Observability**, or **Security**
-        section of the Kibana feature privileges, depending on the owner of the
-        case you're creating.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the case you're creating.
       tags:
         - cases
         - kibana
@@ -2343,11 +2342,11 @@ paths:
       servers:
         - url: https://localhost:5601
     delete:
+      summary: Deletes all comments and alerts from a case.
       description: >
-        Deletes one or all comments from a case. You must have all privileges
-        for the **Cases** feature in the **Management**, **Observability**, or
-        **Security** section of the Kibana feature privileges, depending on the
-        owner of the cases you're deleting.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the cases you're deleting.
       tags:
         - cases
         - kibana
@@ -2360,12 +2359,12 @@ paths:
       servers:
         - url: https://localhost:5601
     patch:
+      summary: Updates a comment or alert in a case.
       description: >
-        Updates a comment in a case. You must have all privileges for the
-        **Cases** feature in the **Management**, **Observability**, or
-        **Security** section of the Kibana feature privileges, depending on the
-        owner of the case you're updating. NOTE: You cannot change the comment
-        type or the owner of a comment.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the case you're updating.
+        NOTE: You cannot change the comment type or the owner of a comment.
       tags:
         - cases
         - kibana
@@ -4697,11 +4696,11 @@ paths:
       - url: https://localhost:5601
   /s/{spaceId}/api/cases/{caseId}/comments:
     post:
+      summary: Adds a comment or alert to a case.
       description: >
-        Adds a comment to a case. You must have all privileges for the **Cases**
-        feature in the **Management**, **Observability**, or **Security**
-        section of the Kibana feature privileges, depending on the owner of the
-        case you're creating.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the case you're creating.
       tags:
         - cases
         - kibana
@@ -4958,11 +4957,11 @@ paths:
       servers:
         - url: https://localhost:5601
     delete:
+      summary: Deletes all comments and alerts from a case.
       description: >
-        Deletes one or all comments from a case. You must have all privileges
-        for the **Cases** feature in the **Management**, **Observability**, or
-        **Security** section of the Kibana feature privileges, depending on the
-        owner of the cases you're deleting.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the cases you're deleting.
       tags:
         - cases
         - kibana
@@ -4976,12 +4975,12 @@ paths:
       servers:
         - url: https://localhost:5601
     patch:
+      summary: Updates a comment or alert in a case.
       description: >
-        Updates a comment in a case. You must have all privileges for the
-        **Cases** feature in the **Management**, **Observability**, or
-        **Security** section of the Kibana feature privileges, depending on the
-        owner of the case you're updating. NOTE: You cannot change the comment
-        type or the owner of a comment.
+        You must have `all` privileges for the **Cases** feature in the
+        **Management**, **Observability**, or **Security** section of the Kibana
+        feature privileges, depending on the owner of the case you're updating.
+        NOTE: You cannot change the comment type or the owner of a comment.
       tags:
         - cases
         - kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments.yaml
@@ -1,10 +1,9 @@
 post:
-  summary: Adds a comment to a case.
+  summary: Adds a comment or alert to a case.
   description: >
-    Adds a comment to a case.
-    You must have all privileges for the **Cases** feature in the **Management**,
-    **Observability**, or **Security** section of the Kibana feature privileges,
-    depending on the owner of the case you're creating.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the case you're creating.
   tags:
     - cases
     - kibana
@@ -37,11 +36,11 @@ post:
      - url: https://localhost:5601
 
 delete:
+  summary: Deletes all comments and alerts from a case.
   description: >
-    Deletes one or all comments from a case. You must have all privileges for
-    the **Cases** feature in the **Management**, **Observability**, or
-    **Security** section of the Kibana feature privileges, depending on the
-    owner of the cases you're deleting.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the cases you're deleting.
   tags:
     - cases
     - kibana
@@ -55,11 +54,12 @@ delete:
     - url: https://localhost:5601
 
 patch:
+  summary: Updates a comment or alert in a case.
   description: >
-    Updates a comment in a case. You must have all privileges for the **Cases**
-    feature in the **Management**, **Observability**, or **Security** section of
-    the Kibana feature privileges, depending on the owner of the case you're
-    updating. NOTE: You cannot change the comment type or the owner of a comment.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the case you're updating.
+    NOTE: You cannot change the comment type or the owner of a comment.
   tags:
     - cases
     - kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments@{commentid}.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments@{commentid}.yaml
@@ -1,7 +1,9 @@
 delete:
+  summary: Deletes a comment or alert from a case.
   description: >
-    Deletes a comment from a case.
-    You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the cases you're deleting.
   tags:
     - cases
     - kibana

diff --git a/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments.yaml b/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments.yaml
@@ -1,9 +1,9 @@
 post:
+  summary: Adds a comment or alert to a case.
   description: >
-    Adds a comment to a case.
-    You must have all privileges for the **Cases** feature in the **Management**,
-    **Observability**, or **Security** section of the Kibana feature privileges,
-    depending on the owner of the case you're creating.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the case you're creating.
   tags:
     - cases
     - kibana
@@ -37,11 +37,11 @@ post:
      - url: https://localhost:5601
 
 delete:
+  summary: Deletes all comments and alerts from a case.
   description: >
-    Deletes one or all comments from a case. You must have all privileges for
-    the **Cases** feature in the **Management**, **Observability**, or
-    **Security** section of the Kibana feature privileges, depending on the
-    owner of the cases you're deleting.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the cases you're deleting.
   tags:
     - cases
     - kibana
@@ -56,11 +56,12 @@ delete:
     - url: https://localhost:5601
 
 patch:
+  summary: Updates a comment or alert in a case.
   description: >
-    Updates a comment in a case. You must have all privileges for the **Cases**
-    feature in the **Management**, **Observability**, or **Security** section of
-    the Kibana feature privileges, depending on the owner of the case you're
-    updating. NOTE: You cannot change the comment type or the owner of a comment.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the case you're updating.
+    NOTE: You cannot change the comment type or the owner of a comment.
   tags:
     - cases
     - kibana

diff --git a/...plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml b/...plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml
@@ -1,7 +1,9 @@
 delete:
+  summary: Deletes a comment or alert from a case.
   description: >
-    Deletes a comment from a case.
-    You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
+    You must have `all` privileges for the **Cases** feature in the
+    **Management**, **Observability**, or **Security** section of the Kibana
+    feature privileges, depending on the owner of the cases you're deleting.
   tags:
     - cases
     - kibana