docs updated

elastic · Jul 19, 2023 · 37c8cdc · 37c8cdc
1 parent b2cda79
commit 37c8cdc
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 92 deletions.
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json
@@ -12,18 +12,26 @@
       "url": "https://www.elastic.co/licensing/elastic-license"
     }
   },
-  "tags": [
-    {
-      "name": "cases",
-      "description": "Case APIs enable you to open and track issues."
-    }
-  ],
   "servers": [
     {
       "url": "http://localhost:5601",
       "description": "local"
     }
   ],
+  "security": [
+    {
+      "basicAuth": []
+    },
+    {
+      "apiKeyAuth": []
+    }
+  ],
+  "tags": [
+    {
+      "name": "cases",
+      "description": "Case APIs enable you to open and track issues."
+    }
+  ],
   "paths": {
     "/api/cases": {
       "post": {
@@ -3977,7 +3985,11 @@
           "type": "string",
           "enum": [
             "createdAt",
-            "updatedAt"
+            "updatedAt",
+            "title",
+            "category",
+            "status",
+            "severity"
           ],
           "default": "createdAt"
         },
@@ -5286,31 +5298,8 @@
         "type": "string",
         "description": "The fields to perform the `simple_query_string` parsed query against.",
         "enum": [
-          "closed_by.username",
-          "closed_by.full_name",
-          "closed_by.email",
-          "closed_by.profile_uid",
-          "created_by.username",
-          "created_by.full_name",
-          "created_by.email",
-          "created_by.profile_uid",
           "description",
-          "connector.name",
-          "connector.type",
-          "external_service.pushed_by.username",
-          "external_service.pushed_by.full_name",
-          "external_service.pushed_by.email",
-          "external_service.pushed_by.profile_uid",
-          "external_service.connector_name",
-          "external_service.external_id",
-          "external_service.external_title",
-          "external_service.external_url",
-          "title",
-          "title.keyword",
-          "updated_by.username",
-          "updated_by.full_name",
-          "updated_by.email",
-          "updated_by.profile_uid"
+          "title"
         ]
       },
       "closure_types": {
@@ -7151,13 +7140,5 @@
         ]
       }
     }
-  },
-  "security": [
-    {
-      "basicAuth": []
-    },
-    {
-      "apiKeyAuth": []
-    }
-  ]
+  }
 }
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
@@ -8,12 +8,15 @@ info:
   license:
     name: Elastic License 2.0
     url: https://www.elastic.co/licensing/elastic-license
-tags:
-  - name: cases
-    description: Case APIs enable you to open and track issues.
 servers:
   - url: http://localhost:5601
     description: local
+security:
+  - basicAuth: []
+  - apiKeyAuth: []
+tags:
+  - name: cases
+    description: Case APIs enable you to open and track issues.
 paths:
   /api/cases:
     post:
@@ -2427,6 +2430,10 @@ components:
         enum:
           - createdAt
           - updatedAt
+          - title
+          - category
+          - status
+          - severity
         default: createdAt
       example: updatedAt
     sort_order:
@@ -3392,31 +3399,8 @@ components:
       type: string
       description: The fields to perform the `simple_query_string` parsed query against.
       enum:
-        - closed_by.username
-        - closed_by.full_name
-        - closed_by.email
-        - closed_by.profile_uid
-        - created_by.username
-        - created_by.full_name
-        - created_by.email
-        - created_by.profile_uid
         - description
-        - connector.name
-        - connector.type
-        - external_service.pushed_by.username
-        - external_service.pushed_by.full_name
-        - external_service.pushed_by.email
-        - external_service.pushed_by.profile_uid
-        - external_service.connector_name
-        - external_service.external_id
-        - external_service.external_title
-        - external_service.external_url
         - title
-        - title.keyword
-        - updated_by.username
-        - updated_by.full_name
-        - updated_by.email
-        - updated_by.profile_uid
     closure_types:
       type: string
       description: Indicates whether a case is automatically closed when it is pushed to external systems (`close-by-pushing`) or not automatically closed (`close-by-user`).
@@ -4768,6 +4752,3 @@ components:
           isPreconfigured: false
           isDeprecated: false
           referencedByCount: 0
-security:
-  - basicAuth: []
-  - apiKeyAuth: []
diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/searchFieldsType.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/searchFieldsType.yaml
@@ -1,28 +1,5 @@
 type: string
 description: The fields to perform the `simple_query_string` parsed query against.
 enum:
-  - closed_by.username
-  - closed_by.full_name
-  - closed_by.email
-  - closed_by.profile_uid
-  - created_by.username
-  - created_by.full_name
-  - created_by.email
-  - created_by.profile_uid
   - description
-  - connector.name
-  - connector.type
-  - external_service.pushed_by.username
-  - external_service.pushed_by.full_name
-  - external_service.pushed_by.email
-  - external_service.pushed_by.profile_uid
-  - external_service.connector_name
-  - external_service.external_id
-  - external_service.external_title
-  - external_service.external_url
   - title
-  - title.keyword
-  - updated_by.username
-  - updated_by.full_name
-  - updated_by.email
-  - updated_by.profile_uid
diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/sortField.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/sortField.yaml
@@ -6,5 +6,9 @@ schema:
   enum:
     - createdAt
     - updatedAt
+    - title
+    - category
+    - status
+    - severity
   default: createdAt
 example: updatedAt