[DOCS] Sort query parameter order; generate preview docs

elastic · Jun 20, 2023 · b306423 · b306423
1 parent f8ecc81
commit b306423
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 40 deletions.
diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc
@@ -724,7 +724,9 @@ Any modifications made to this file will be overwritten.
     <div class="field-items">
       <div class="param">assignees (optional)</div>
 
-      <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by assignees. Valid values are <code>none</code> or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. default: null </div><div class="param">defaultSearchOperator (optional)</div>
+      <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by assignees. Valid values are <code>none</code> or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. default: null </div><div class="param">category (optional)</div>
+
+      <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by category. Limited to 100 categories. default: null </div><div class="param">defaultSearchOperator (optional)</div>
 
       <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The default operator to use for the simple_query_string. default: OR </div><div class="param">from (optional)</div>
 

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json
@@ -236,6 +236,25 @@
               ]
             }
           },
+          {
+            "name": "category",
+            "in": "query",
+            "description": "Filters the returned cases by category. Limited to 100 categories.",
+            "schema": {
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            "example": "my-category"
+          },
           {
             "name": "defaultSearchOperator",
             "in": "query",
@@ -362,25 +381,6 @@
             },
             "example": "tag-1"
           },
-          {
-            "name": "category",
-            "in": "query",
-            "description": "Filters the returned cases by category. Limited to 100 categories.",
-            "schema": {
-              "oneOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              ]
-            },
-            "example": "my-category"
-          },
           {
             "name": "to",
             "in": "query",

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
@@ -140,6 +140,16 @@ paths:
               - type: array
                 items:
                   type: string
+        - name: category
+          in: query
+          description: Filters the returned cases by category. Limited to 100 categories.
+          schema:
+            oneOf:
+              - type: string
+              - type: array
+                items:
+                  type: string
+          example: my-category
         - name: defaultSearchOperator
           in: query
           description: The default operator to use for the simple_query_string.
@@ -213,16 +223,6 @@ paths:
                 items:
                   type: string
           example: tag-1
-        - name: category
-          in: query
-          description: Filters the returned cases by category. Limited to 100 categories.
-          schema:
-            oneOf:
-              - type: string
-              - type: array
-                items:
-                  type: string
-          example: my-category
         - name: to
           in: query
           description: |

diff --git a/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml
@@ -18,6 +18,16 @@ get:
           - type: array
             items:
               type: string
+    - name: category
+      in: query
+      description: Filters the returned cases by category. Limited to 100 categories.
+      schema:
+        oneOf:
+          - type: string
+          - type: array
+            items:
+              type: string
+      example: my-category
     - name: defaultSearchOperator
       in: query
       description: The default operator to use for the simple_query_string.
@@ -96,16 +106,6 @@ get:
             items:
               type: string
       example: tag-1
-    - name: category
-      in: query
-      description: Filters the returned cases by category. Limited to 100 categories.
-      schema:
-        oneOf:
-          - type: string
-          - type: array
-            items:
-              type: string
-      example: my-category
     - name: to
       in: query
       description: >