From b30642342c316cebb8b557bbec14d0a13c106005 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 20 Jun 2023 08:32:30 -0700 Subject: [PATCH] [DOCS] Sort query parameter order; generate preview docs --- .../cases/case-apis-passthru.asciidoc | 4 +- .../plugins/cases/docs/openapi/bundled.json | 38 +++++++++---------- .../plugins/cases/docs/openapi/bundled.yaml | 20 +++++----- .../paths/s@{spaceid}@api@cases@_find.yaml | 20 +++++----- 4 files changed, 42 insertions(+), 40 deletions(-) diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index d983ab1d2a099..d0e7a67c50660 100644 --- 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.
assignees (optional)
-
Query Parameter — Filters the returned cases by assignees. Valid values are none or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. default: null
defaultSearchOperator (optional)
+
Query Parameter — Filters the returned cases by assignees. Valid values are none or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. default: null
category (optional)
+ +
Query Parameter — Filters the returned cases by category. Limited to 100 categories. default: null
defaultSearchOperator (optional)
Query Parameter — The default operator to use for the simple_query_string. default: OR
from (optional)
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json index 4689e8be04f43..92dcfe5779306 100644 --- 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 index d7c0fed15e446..3d53916c89df8 100644 --- 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 index bed1182316437..e04fbfe020c9f 100644 --- 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: >