diff --git a/oas_docs/output/kibana.staging.yaml b/oas_docs/output/kibana.staging.yaml index c6abc2667da3d..6cf51dfcb6062 100644 --- a/oas_docs/output/kibana.staging.yaml +++ b/oas_docs/output/kibana.staging.yaml @@ -6941,7 +6941,7 @@ paths: - $ref: '#/components/parameters/Cases_category' - $ref: '#/components/parameters/Cases_defaultSearchOperator' - $ref: '#/components/parameters/Cases_from' - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' - $ref: '#/components/parameters/Cases_page_index' - $ref: '#/components/parameters/Cases_page_size' - $ref: '#/components/parameters/Cases_reporters' @@ -7389,7 +7389,7 @@ paths: operationId: getCasesByAlertDefaultSpace parameters: - $ref: '#/components/parameters/Cases_alert_id' - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -7430,7 +7430,7 @@ paths: where the cases were created. operationId: getCaseConfigurationDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -7561,7 +7561,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -7609,7 +7609,7 @@ paths: post: description: > Case settings include external connection details, custom fields, and - templates. Connectors are used to interface with external systems. You + templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still @@ -7757,7 +7757,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -7953,7 +7953,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -8062,7 +8062,7 @@ paths: returned by this API is unchanged. operationId: getCaseReportersDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -8117,7 +8117,7 @@ paths: privileges, depending on the owner of the cases you're seeking. operationId: getCaseStatusDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -8150,7 +8150,7 @@ paths: privileges, depending on the owner of the cases you're seeking. operationId: getCaseTagsDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -24210,11 +24210,8 @@ components: name: assignees schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_case_id: description: >- The identifier for the case. To retrieve case IDs, use the find cases @@ -24231,12 +24228,8 @@ components: name: category schema: oneOf: - - example: my-category - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_case_category' + - $ref: '#/components/schemas/Cases_case_categories' Cases_comment_id: description: > The identifier for the comment. To retrieve comment IDs, use the get @@ -24313,7 +24306,7 @@ components: required: true schema: type: string - Cases_owner: + Cases_owner_filter: description: > A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all @@ -24323,10 +24316,8 @@ components: name: owner schema: oneOf: + - $ref: '#/components/schemas/Cases_owner' - $ref: '#/components/schemas/Cases_owners' - - items: - $ref: '#/components/schemas/Cases_owners' - type: array Cases_page_index: description: The page number to return. in: query @@ -24351,11 +24342,8 @@ components: name: reporters schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_search: description: >- An Elasticsearch simple_query_string query that filters the objects in @@ -24371,9 +24359,7 @@ components: schema: oneOf: - $ref: '#/components/schemas/Cases_searchFieldsType' - - items: - $ref: '#/components/schemas/Cases_searchFieldsType' - type: array + - $ref: '#/components/schemas/Cases_searchFieldsTypeArray' Cases_severity: description: The severity of the case. in: query @@ -24430,11 +24416,8 @@ components: name: tags schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_to: description: > Returns only cases that were created before a specific date. The date @@ -24835,7 +24818,7 @@ components: index: $ref: '#/components/schemas/Cases_alert_indices' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: $ref: '#/components/schemas/Cases_rule' type: @@ -24873,7 +24856,7 @@ components: maxLength: 30000 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: description: The type of comment. enum: @@ -24930,7 +24913,7 @@ components: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' pushed_at: example: null format: date-time @@ -25073,6 +25056,11 @@ components: maxItems: 10 nullable: true type: array + Cases_case_categories: + items: + $ref: '#/components/schemas/Cases_case_category' + maxItems: 100 + type: array Cases_case_category: description: A word or phrase that categorizes the case. maxLength: 50 @@ -25234,7 +25222,7 @@ components: example: 66b9aa00-94fa-11ea-9f74-e7e108796192 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -25766,7 +25754,7 @@ components: description: $ref: '#/components/schemas/Cases_case_description' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -25820,7 +25808,7 @@ components: example: elastic nullable: true type: string - Cases_owners: + Cases_owner: description: > The application that owns the cases: Stack Management, Observability, or Elastic Security. @@ -25830,6 +25818,10 @@ components: - securitySolution example: cases type: string + Cases_owners: + items: + $ref: '#/components/schemas/Cases_owner' + type: array Cases_payload_alert_comment: type: object properties: @@ -25851,7 +25843,7 @@ components: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: type: object properties: @@ -26081,7 +26073,7 @@ components: description: type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -26150,7 +26142,7 @@ components: comment: type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: enum: - user @@ -26180,6 +26172,10 @@ components: - description - title type: string + Cases_searchFieldsTypeArray: + items: + $ref: '#/components/schemas/Cases_searchFieldsType' + type: array Cases_set_case_configuration_request: description: >- External connection details, such as the closure type and default @@ -26266,7 +26262,7 @@ components: minItems: 0 type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' required: @@ -26285,6 +26281,13 @@ components: type: boolean required: - syncAlerts + Cases_string: + type: string + Cases_string_array: + items: + $ref: '#/components/schemas/Cases_string' + maxItems: 100 + type: array Cases_template_tags: description: > The words and phrases that help categorize templates. It can be an empty @@ -26397,7 +26400,7 @@ components: index: $ref: '#/components/schemas/Cases_alert_indices' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: $ref: '#/components/schemas/Cases_rule' type: @@ -26641,7 +26644,7 @@ components: example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: description: The type of comment. enum: @@ -26701,7 +26704,7 @@ components: example: 22fd3e30-03b1-11ed-920c-974bfa104448 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' payload: oneOf: - $ref: '#/components/schemas/Cases_payload_alert_comment' @@ -26788,7 +26791,7 @@ components: - full_name - username owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' payload: oneOf: - $ref: '#/components/schemas/Cases_payload_alert_comment' @@ -26833,7 +26836,7 @@ components: example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' pushed_at: example: null format: date-time diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index c6abc2667da3d..6cf51dfcb6062 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -6941,7 +6941,7 @@ paths: - $ref: '#/components/parameters/Cases_category' - $ref: '#/components/parameters/Cases_defaultSearchOperator' - $ref: '#/components/parameters/Cases_from' - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' - $ref: '#/components/parameters/Cases_page_index' - $ref: '#/components/parameters/Cases_page_size' - $ref: '#/components/parameters/Cases_reporters' @@ -7389,7 +7389,7 @@ paths: operationId: getCasesByAlertDefaultSpace parameters: - $ref: '#/components/parameters/Cases_alert_id' - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -7430,7 +7430,7 @@ paths: where the cases were created. operationId: getCaseConfigurationDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -7561,7 +7561,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -7609,7 +7609,7 @@ paths: post: description: > Case settings include external connection details, custom fields, and - templates. Connectors are used to interface with external systems. You + templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still @@ -7757,7 +7757,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -7953,7 +7953,7 @@ paths: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' updated_at: @@ -8062,7 +8062,7 @@ paths: returned by this API is unchanged. operationId: getCaseReportersDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -8117,7 +8117,7 @@ paths: privileges, depending on the owner of the cases you're seeking. operationId: getCaseStatusDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -8150,7 +8150,7 @@ paths: privileges, depending on the owner of the cases you're seeking. operationId: getCaseTagsDefaultSpace parameters: - - $ref: '#/components/parameters/Cases_owner' + - $ref: '#/components/parameters/Cases_owner_filter' responses: '200': content: @@ -24210,11 +24210,8 @@ components: name: assignees schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_case_id: description: >- The identifier for the case. To retrieve case IDs, use the find cases @@ -24231,12 +24228,8 @@ components: name: category schema: oneOf: - - example: my-category - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_case_category' + - $ref: '#/components/schemas/Cases_case_categories' Cases_comment_id: description: > The identifier for the comment. To retrieve comment IDs, use the get @@ -24313,7 +24306,7 @@ components: required: true schema: type: string - Cases_owner: + Cases_owner_filter: description: > A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all @@ -24323,10 +24316,8 @@ components: name: owner schema: oneOf: + - $ref: '#/components/schemas/Cases_owner' - $ref: '#/components/schemas/Cases_owners' - - items: - $ref: '#/components/schemas/Cases_owners' - type: array Cases_page_index: description: The page number to return. in: query @@ -24351,11 +24342,8 @@ components: name: reporters schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_search: description: >- An Elasticsearch simple_query_string query that filters the objects in @@ -24371,9 +24359,7 @@ components: schema: oneOf: - $ref: '#/components/schemas/Cases_searchFieldsType' - - items: - $ref: '#/components/schemas/Cases_searchFieldsType' - type: array + - $ref: '#/components/schemas/Cases_searchFieldsTypeArray' Cases_severity: description: The severity of the case. in: query @@ -24430,11 +24416,8 @@ components: name: tags schema: oneOf: - - type: string - - items: - type: string - maxItems: 100 - type: array + - $ref: '#/components/schemas/Cases_string' + - $ref: '#/components/schemas/Cases_string_array' Cases_to: description: > Returns only cases that were created before a specific date. The date @@ -24835,7 +24818,7 @@ components: index: $ref: '#/components/schemas/Cases_alert_indices' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: $ref: '#/components/schemas/Cases_rule' type: @@ -24873,7 +24856,7 @@ components: maxLength: 30000 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: description: The type of comment. enum: @@ -24930,7 +24913,7 @@ components: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' pushed_at: example: null format: date-time @@ -25073,6 +25056,11 @@ components: maxItems: 10 nullable: true type: array + Cases_case_categories: + items: + $ref: '#/components/schemas/Cases_case_category' + maxItems: 100 + type: array Cases_case_category: description: A word or phrase that categorizes the case. maxLength: 50 @@ -25234,7 +25222,7 @@ components: example: 66b9aa00-94fa-11ea-9f74-e7e108796192 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -25766,7 +25754,7 @@ components: description: $ref: '#/components/schemas/Cases_case_description' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -25820,7 +25808,7 @@ components: example: elastic nullable: true type: string - Cases_owners: + Cases_owner: description: > The application that owns the cases: Stack Management, Observability, or Elastic Security. @@ -25830,6 +25818,10 @@ components: - securitySolution example: cases type: string + Cases_owners: + items: + $ref: '#/components/schemas/Cases_owner' + type: array Cases_payload_alert_comment: type: object properties: @@ -25851,7 +25843,7 @@ components: type: string type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: type: object properties: @@ -26081,7 +26073,7 @@ components: description: type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' settings: $ref: '#/components/schemas/Cases_settings' severity: @@ -26150,7 +26142,7 @@ components: comment: type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: enum: - user @@ -26180,6 +26172,10 @@ components: - description - title type: string + Cases_searchFieldsTypeArray: + items: + $ref: '#/components/schemas/Cases_searchFieldsType' + type: array Cases_set_case_configuration_request: description: >- External connection details, such as the closure type and default @@ -26266,7 +26262,7 @@ components: minItems: 0 type: array owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' templates: $ref: '#/components/schemas/Cases_templates' required: @@ -26285,6 +26281,13 @@ components: type: boolean required: - syncAlerts + Cases_string: + type: string + Cases_string_array: + items: + $ref: '#/components/schemas/Cases_string' + maxItems: 100 + type: array Cases_template_tags: description: > The words and phrases that help categorize templates. It can be an empty @@ -26397,7 +26400,7 @@ components: index: $ref: '#/components/schemas/Cases_alert_indices' owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' rule: $ref: '#/components/schemas/Cases_rule' type: @@ -26641,7 +26644,7 @@ components: example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' type: description: The type of comment. enum: @@ -26701,7 +26704,7 @@ components: example: 22fd3e30-03b1-11ed-920c-974bfa104448 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' payload: oneOf: - $ref: '#/components/schemas/Cases_payload_alert_comment' @@ -26788,7 +26791,7 @@ components: - full_name - username owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' payload: oneOf: - $ref: '#/components/schemas/Cases_payload_alert_comment' @@ -26833,7 +26836,7 @@ components: example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 type: string owner: - $ref: '#/components/schemas/Cases_owners' + $ref: '#/components/schemas/Cases_owner' pushed_at: example: null format: date-time diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json index 44093a1dfdb51..659ab18aab155 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.json +++ b/x-pack/plugins/cases/docs/openapi/bundled.json @@ -191,7 +191,7 @@ "$ref": "#/components/parameters/from" }, { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" }, { "$ref": "#/components/parameters/page_index" @@ -297,7 +297,7 @@ "$ref": "#/components/parameters/alert_id" }, { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" } ], "responses": { @@ -354,7 +354,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" } ], "responses": { @@ -501,7 +501,7 @@ } }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "templates": { "$ref": "#/components/schemas/templates" @@ -572,7 +572,7 @@ "post": { "summary": "Add case settings", "operationId": "setCaseConfigurationDefaultSpace", - "description": "Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.\n", + "description": "Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.\n", "tags": [ "cases" ], @@ -737,7 +737,7 @@ } }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "templates": { "$ref": "#/components/schemas/templates" @@ -977,7 +977,7 @@ } }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "templates": { "$ref": "#/components/schemas/templates" @@ -1055,7 +1055,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" } ], "responses": { @@ -1128,7 +1128,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" } ], "responses": { @@ -1176,7 +1176,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/owner_filter" } ], "responses": { @@ -1904,14 +1904,10 @@ "schema": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/string" }, { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 100 + "$ref": "#/components/schemas/string_array" } ] } @@ -1923,15 +1919,10 @@ "schema": { "oneOf": [ { - "type": "string", - "example": "my-category" + "$ref": "#/components/schemas/case_category" }, { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 100 + "$ref": "#/components/schemas/case_categories" } ] } @@ -1955,20 +1946,17 @@ "example": "now-1d" } }, - "owner": { + "owner_filter": { "in": "query", "name": "owner", "description": "A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.\n", "schema": { "oneOf": [ { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/owners" - } + "$ref": "#/components/schemas/owners" } ] }, @@ -2002,14 +1990,10 @@ "schema": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/string" }, { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 100 + "$ref": "#/components/schemas/string_array" } ] }, @@ -2033,10 +2017,7 @@ "$ref": "#/components/schemas/searchFieldsType" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/searchFieldsType" - } + "$ref": "#/components/schemas/searchFieldsTypeArray" } ] } @@ -2109,14 +2090,10 @@ "schema": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/string" }, { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 100 + "$ref": "#/components/schemas/string_array" } ] }, @@ -2612,7 +2589,7 @@ "type": "string", "maxLength": 30000 }, - "owners": { + "owner": { "type": "string", "description": "The application that owns the cases: Stack Management, Observability, or Elastic Security.\n", "enum": [ @@ -2711,7 +2688,7 @@ "$ref": "#/components/schemas/case_description" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "settings": { "$ref": "#/components/schemas/settings" @@ -2863,7 +2840,7 @@ } }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "pushed_at": { "type": "string", @@ -2988,7 +2965,7 @@ "example": "8af6ac20-74f6-11ea-b83a-553aecdb28b6" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "pushed_at": { "type": "string", @@ -3337,7 +3314,7 @@ "example": "66b9aa00-94fa-11ea-9f74-e7e108796192" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "settings": { "$ref": "#/components/schemas/settings" @@ -3525,6 +3502,29 @@ } } }, + "string": { + "type": "string" + }, + "string_array": { + "type": "array", + "items": { + "$ref": "#/components/schemas/string" + }, + "maxItems": 100 + }, + "case_categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/case_category" + }, + "maxItems": 100 + }, + "owners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/owner" + } + }, "searchFieldsType": { "type": "string", "description": "The fields to perform the `simple_query_string` parsed query against.", @@ -3533,6 +3533,12 @@ "title" ] }, + "searchFieldsTypeArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/searchFieldsType" + } + }, "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`).", @@ -3767,7 +3773,7 @@ } }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "templates": { "$ref": "#/components/schemas/templates" @@ -3911,7 +3917,7 @@ "$ref": "#/components/schemas/alert_indices" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "rule": { "$ref": "#/components/schemas/rule" @@ -3938,7 +3944,7 @@ "example": "A new comment." }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "type": { "type": "string", @@ -4053,7 +4059,7 @@ "$ref": "#/components/schemas/alert_indices" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "rule": { "$ref": "#/components/schemas/rule" @@ -4090,7 +4096,7 @@ "example": "8af6ac20-74f6-11ea-b83a-553aecdb28b6" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "type": { "type": "string", @@ -4179,7 +4185,7 @@ ] }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "rule": { "type": "object", @@ -4415,7 +4421,7 @@ "type": "string" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "settings": { "$ref": "#/components/schemas/settings" @@ -4517,7 +4523,7 @@ "type": "string" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "type": { "type": "string", @@ -4613,7 +4619,7 @@ ] }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "payload": { "oneOf": [ @@ -4724,7 +4730,7 @@ "example": "22fd3e30-03b1-11ed-920c-974bfa104448" }, "owner": { - "$ref": "#/components/schemas/owners" + "$ref": "#/components/schemas/owner" }, "payload": { "oneOf": [ diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml index 4702121fb4b30..db2a7960614d9 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled.yaml @@ -116,7 +116,7 @@ paths: - $ref: '#/components/parameters/category' - $ref: '#/components/parameters/defaultSearchOperator' - $ref: '#/components/parameters/from' - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' - $ref: '#/components/parameters/page_index' - $ref: '#/components/parameters/page_size' - $ref: '#/components/parameters/reporters' @@ -173,7 +173,7 @@ paths: - cases parameters: - $ref: '#/components/parameters/alert_id' - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' responses: '200': description: Indicates a successful call. @@ -209,7 +209,7 @@ paths: tags: - cases parameters: - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' responses: '200': description: Indicates a successful call. @@ -320,7 +320,7 @@ paths: type: string example: summary owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' templates: $ref: '#/components/schemas/templates' updated_at: @@ -367,7 +367,7 @@ paths: summary: Add case settings operationId: setCaseConfigurationDefaultSpace description: | - Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases. + Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases. tags: - cases parameters: @@ -488,7 +488,7 @@ paths: type: string example: summary owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' templates: $ref: '#/components/schemas/templates' updated_at: @@ -658,7 +658,7 @@ paths: type: string example: summary owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' templates: $ref: '#/components/schemas/templates' updated_at: @@ -710,7 +710,7 @@ paths: tags: - cases parameters: - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' responses: '200': description: Indicates a successful call. @@ -760,7 +760,7 @@ paths: tags: - cases parameters: - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' responses: '200': description: Indicates a successful call. @@ -790,7 +790,7 @@ paths: tags: - cases parameters: - - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/owner_filter' responses: '200': description: Indicates a successful call. @@ -1237,23 +1237,16 @@ components: 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. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '#/components/schemas/string' + - $ref: '#/components/schemas/string_array' category: in: query name: category description: Filters the returned cases by category. schema: oneOf: - - type: string - example: my-category - - type: array - items: - type: string - maxItems: 100 + - $ref: '#/components/schemas/case_category' + - $ref: '#/components/schemas/case_categories' defaultSearchOperator: in: query name: defaultSearchOperator @@ -1270,17 +1263,15 @@ components: schema: type: string example: now-1d - owner: + owner_filter: in: query name: owner description: | A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read. schema: oneOf: + - $ref: '#/components/schemas/owner' - $ref: '#/components/schemas/owners' - - type: array - items: - $ref: '#/components/schemas/owners' example: cases page_index: in: query @@ -1305,11 +1296,8 @@ components: description: Filters the returned cases by the user name of the reporter. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '#/components/schemas/string' + - $ref: '#/components/schemas/string_array' example: elastic search: in: query @@ -1324,9 +1312,7 @@ components: schema: oneOf: - $ref: '#/components/schemas/searchFieldsType' - - type: array - items: - $ref: '#/components/schemas/searchFieldsType' + - $ref: '#/components/schemas/searchFieldsTypeArray' severity: in: query name: severity @@ -1382,11 +1368,8 @@ components: description: Filters the returned cases by tags. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '#/components/schemas/string' + - $ref: '#/components/schemas/string_array' example: tag-1 to: in: query @@ -1770,7 +1753,7 @@ components: description: The description for the case. type: string maxLength: 30000 - owners: + owner: type: string description: | The application that owns the cases: Stack Management, Observability, or Elastic Security. @@ -1840,7 +1823,7 @@ components: description: $ref: '#/components/schemas/case_description' owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' settings: $ref: '#/components/schemas/settings' severity: @@ -1954,7 +1937,7 @@ components: type: string example: .internal.alerts-security.alerts-default-000001 owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' pushed_at: type: string format: date-time @@ -2048,7 +2031,7 @@ components: type: string example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' pushed_at: type: string format: date-time @@ -2304,7 +2287,7 @@ components: type: string example: 66b9aa00-94fa-11ea-9f74-e7e108796192 owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' settings: $ref: '#/components/schemas/settings' severity: @@ -2430,12 +2413,32 @@ components: version: description: The current version of the case. To determine this value, use the get case or find cases APIs. type: string + string: + type: string + string_array: + type: array + items: + $ref: '#/components/schemas/string' + maxItems: 100 + case_categories: + type: array + items: + $ref: '#/components/schemas/case_category' + maxItems: 100 + owners: + type: array + items: + $ref: '#/components/schemas/owner' searchFieldsType: type: string description: The fields to perform the `simple_query_string` parsed query against. enum: - description - title + searchFieldsTypeArray: + type: array + items: + $ref: '#/components/schemas/searchFieldsType' 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`). @@ -2612,7 +2615,7 @@ components: - text - toggle owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' templates: $ref: '#/components/schemas/templates' update_case_configuration_request: @@ -2721,7 +2724,7 @@ components: index: $ref: '#/components/schemas/alert_indices' owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' rule: $ref: '#/components/schemas/rule' type: @@ -2741,7 +2744,7 @@ components: maxLength: 30000 example: A new comment. owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' type: type: string description: The type of comment. @@ -2824,7 +2827,7 @@ components: index: $ref: '#/components/schemas/alert_indices' owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' rule: $ref: '#/components/schemas/rule' type: @@ -2854,7 +2857,7 @@ components: The identifier for the comment. To retrieve comment IDs, use the get comments API. example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' type: type: string description: The type of comment. @@ -2913,7 +2916,7 @@ components: items: type: string owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' rule: type: object properties: @@ -3085,7 +3088,7 @@ components: description: type: string owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' settings: $ref: '#/components/schemas/settings' severity: @@ -3152,7 +3155,7 @@ components: comment: type: string owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' type: type: string enum: @@ -3226,7 +3229,7 @@ components: - full_name - username owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' payload: oneOf: - $ref: '#/components/schemas/payload_alert_comment' @@ -3293,7 +3296,7 @@ components: type: string example: 22fd3e30-03b1-11ed-920c-974bfa104448 owner: - $ref: '#/components/schemas/owners' + $ref: '#/components/schemas/owner' payload: oneOf: - $ref: '#/components/schemas/payload_alert_comment' diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/assignees_filter.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/assignees_filter.yaml index a4c81c67f6c67..370365aae50fb 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/assignees_filter.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/assignees_filter.yaml @@ -6,8 +6,5 @@ description: > These identifiers can be found by using the suggest user profile API. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '../schemas/string.yaml' + - $ref: '../schemas/string_array.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/category.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/category.yaml index 4fd903b11f479..c8aa8f1a7935a 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/category.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/category.yaml @@ -3,9 +3,5 @@ name: category description: Filters the returned cases by category. schema: oneOf: - - type: string - example: my-category - - type: array - items: - type: string - maxItems: 100 \ No newline at end of file + - $ref: '../schemas/case_category.yaml' + - $ref: '../schemas/case_categories.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/owner.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/owner_filter.yaml similarity index 76% rename from x-pack/plugins/cases/docs/openapi/components/parameters/owner.yaml rename to x-pack/plugins/cases/docs/openapi/components/parameters/owner_filter.yaml index 3c5e511742bf2..90f97aa0c6c69 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/owner.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/owner_filter.yaml @@ -6,8 +6,6 @@ description: > that the user has access to read. schema: oneOf: + - $ref: '../schemas/owner.yaml' - $ref: '../schemas/owners.yaml' - - type: array - items: - $ref: '../schemas/owners.yaml' -example: cases \ No newline at end of file +example: cases diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/reporters.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/reporters.yaml index db28a6c48ae02..919121cbbb842 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/reporters.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/reporters.yaml @@ -3,9 +3,6 @@ name: reporters description: Filters the returned cases by the user name of the reporter. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '../schemas/string.yaml' + - $ref: '../schemas/string_array.yaml' example: elastic diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/searchFields.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/searchFields.yaml index 8b06f182aade8..17f7c4c4548a0 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/searchFields.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/searchFields.yaml @@ -4,6 +4,4 @@ description: The fields to perform the simple_query_string parsed query against. schema: oneOf: - $ref: 'searchFieldsType.yaml' - - type: array - items: - $ref: 'searchFieldsType.yaml' \ No newline at end of file + - $ref: 'searchFieldsTypeArray.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/searchFieldsTypeArray.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/searchFieldsTypeArray.yaml new file mode 100644 index 0000000000000..1241848a958a4 --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/searchFieldsTypeArray.yaml @@ -0,0 +1,3 @@ +type: array +items: + $ref: 'searchFieldsType.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/parameters/tags.yaml b/x-pack/plugins/cases/docs/openapi/components/parameters/tags.yaml index d899edbcc38eb..76aa56b91ede9 100644 --- a/x-pack/plugins/cases/docs/openapi/components/parameters/tags.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/parameters/tags.yaml @@ -3,9 +3,6 @@ name: tags description: Filters the returned cases by tags. schema: oneOf: - - type: string - - type: array - items: - type: string - maxItems: 100 + - $ref: '../schemas/string.yaml' + - $ref: '../schemas/string_array.yaml' example: tag-1 diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/add_alert_comment_request_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/add_alert_comment_request_properties.yaml index c99ebb19cc818..064774e1ae282 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/add_alert_comment_request_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/add_alert_comment_request_properties.yaml @@ -13,12 +13,12 @@ properties: index: $ref: 'alert_indices.yaml' owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' rule: $ref: 'rule.yaml' - type: + type: description: The type of comment. type: string example: alert enum: - - alert \ No newline at end of file + - alert diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/add_user_comment_request_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/add_user_comment_request_properties.yaml index beac63c377ade..0fdc79002a10e 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/add_user_comment_request_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/add_user_comment_request_properties.yaml @@ -8,8 +8,8 @@ properties: maxLength: 30000 example: A new comment. owner: - $ref: 'owners.yaml' - type: + $ref: 'owner.yaml' + type: type: string description: The type of comment. example: user @@ -18,4 +18,4 @@ properties: required: - comment - owner - - type \ No newline at end of file + - type diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_comment_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_comment_response_properties.yaml index 443d9dcc55523..fa616e1f2220d 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_comment_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_comment_response_properties.yaml @@ -29,7 +29,7 @@ properties: type: string example: .internal.alerts-security.alerts-default-000001 owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' pushed_at: type: string format: date-time @@ -68,4 +68,4 @@ properties: $ref: 'user_properties.yaml' version: type: string - example: WzMwNDgsMV0= \ No newline at end of file + example: WzMwNDgsMV0= diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_categories.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_categories.yaml new file mode 100644 index 0000000000000..35f20183feeef --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_categories.yaml @@ -0,0 +1,4 @@ +type: array +items: + $ref: './case_category.yaml' +maxItems: 100 diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml index 07a94129b0180..24739d21e49ae 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_configure_response_properties.yaml @@ -45,7 +45,7 @@ mappings: type: string example: summary owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' templates: $ref: 'templates.yaml' updated_at: diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml index 0c4560dc6362a..175b3408c282d 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/case_response_properties.yaml @@ -100,7 +100,7 @@ properties: type: string example: 66b9aa00-94fa-11ea-9f74-e7e108796192 owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' settings: $ref: 'settings.yaml' severity: diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml index 94e9ecae9254d..a2499239f97cd 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml @@ -24,7 +24,7 @@ properties: description: $ref: 'case_description.yaml' owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' settings: $ref: 'settings.yaml' severity: diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/owner.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/owner.yaml new file mode 100644 index 0000000000000..9036fd5a3833a --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/owner.yaml @@ -0,0 +1,9 @@ +type: string +description: > + The application that owns the cases: Stack Management, Observability, or + Elastic Security. +enum: + - cases + - observability + - securitySolution +example: cases \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/owners.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/owners.yaml index 9036fd5a3833a..4a7818e04d986 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/owners.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/owners.yaml @@ -1,9 +1,3 @@ -type: string -description: > - The application that owns the cases: Stack Management, Observability, or - Elastic Security. -enum: - - cases - - observability - - securitySolution -example: cases \ No newline at end of file +type: array +items: + $ref: './owner.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_alert_comment.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_alert_comment.yaml index 0b0d3fc3c07ce..170704dcd1807 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_alert_comment.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_alert_comment.yaml @@ -18,7 +18,7 @@ properties: items: type: string owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' rule: type: object properties: @@ -26,4 +26,4 @@ properties: type: type: string enum: - - alert \ No newline at end of file + - alert diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml index 728614cd36692..08b2e6f56a61d 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_create_case.yaml @@ -2,24 +2,24 @@ type: object properties: assignees: $ref: 'assignees.yaml' - connector: + connector: type: object properties: $ref: 'connector_properties.yaml' description: type: string owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' settings: $ref: 'settings.yaml' severity: $ref: 'case_severity.yaml' - status: + status: $ref: 'case_status.yaml' - tags: + tags: type: array items: type: string example: ["tag-1"] title: - type: string \ No newline at end of file + type: string diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_user_comment.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_user_comment.yaml index e07d5f81359b2..b285612b28a0f 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/payload_user_comment.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/payload_user_comment.yaml @@ -6,8 +6,8 @@ properties: comment: type: string owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' type: type: string enum: - - user \ No newline at end of file + - user diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml index dd275406264b5..766bb09105a65 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/set_case_configuration_request.yaml @@ -33,6 +33,6 @@ properties: properties: $ref: 'case_configure_customfields.yaml' owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' templates: $ref: 'templates.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/string.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/string.yaml new file mode 100644 index 0000000000000..5c21d88b9e5c0 --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/string.yaml @@ -0,0 +1 @@ +type: string diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/string_array.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/string_array.yaml new file mode 100644 index 0000000000000..c2598d4b2b33e --- /dev/null +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/string_array.yaml @@ -0,0 +1,4 @@ +type: array +items: + $ref: './string.yaml' +maxItems: 100 diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/update_alert_comment_request_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/update_alert_comment_request_properties.yaml index 2c7bd5dcc1215..cf53ed1b451a1 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/update_alert_comment_request_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/update_alert_comment_request_properties.yaml @@ -21,10 +21,10 @@ properties: index: $ref: 'alert_indices.yaml' owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' rule: $ref: 'rule.yaml' - type: + type: description: The type of comment. type: string enum: @@ -35,4 +35,4 @@ properties: The current comment version. To retrieve version values, use the get comments API. type: string - example: Wzk1LDFd \ No newline at end of file + example: Wzk1LDFd diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/update_user_comment_request_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/update_user_comment_request_properties.yaml index a83050e93eaaf..a639ee1e603c8 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/update_user_comment_request_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/update_user_comment_request_properties.yaml @@ -14,8 +14,8 @@ properties: get comments API. example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 owner: - $ref: 'owners.yaml' - type: + $ref: 'owner.yaml' + type: type: string description: The type of comment. enum: @@ -32,4 +32,4 @@ required: - id - owner - type - - version \ No newline at end of file + - version diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_find_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_find_response_properties.yaml index a17f98d8007ad..99a13ff167558 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_find_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_find_response_properties.yaml @@ -32,7 +32,7 @@ properties: type: string example: 22fd3e30-03b1-11ed-920c-974bfa104448 owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' payload: oneOf: - $ref: 'payload_alert_comment.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml index ef39c531c357d..b6253e4a2a533 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/user_actions_response_properties.yaml @@ -35,7 +35,7 @@ properties: - full_name - username owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' payload: oneOf: - $ref: 'payload_alert_comment.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/user_comment_response_properties.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/user_comment_response_properties.yaml index b1727d3279abe..1fb76c222ef3b 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/user_comment_response_properties.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/user_comment_response_properties.yaml @@ -16,7 +16,7 @@ properties: type: string example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6 owner: - $ref: 'owners.yaml' + $ref: 'owner.yaml' pushed_at: type: string format: date-time @@ -24,7 +24,7 @@ properties: example: null pushed_by: $ref: 'case_response_pushed_by_properties.yaml' - type: + type: type: string example: user enum: @@ -38,4 +38,4 @@ properties: $ref: 'case_response_updated_by_properties.yaml' version: type: string - example: WzIwNDMxLDFd \ No newline at end of file + example: WzIwNDMxLDFd 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 index a8f6175e98842..cbe2af1c25afb 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml @@ -12,7 +12,7 @@ get: - $ref: '../components/parameters/category.yaml' - $ref: '../components/parameters/defaultSearchOperator.yaml' - $ref: '../components/parameters/from.yaml' - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' - $ref: '../components/parameters/page_index.yaml' - $ref: '../components/parameters/page_size.yaml' - $ref: '../components/parameters/reporters.yaml' 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 index 0531c2675bce2..cef35ea078520 100644 --- 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 @@ -10,7 +10,7 @@ get: - cases parameters: - $ref: ../components/parameters/alert_id.yaml - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' responses: '200': description: Indicates a successful call. @@ -19,7 +19,7 @@ get: schema: type: array maxItems: 10000 - items: + items: type: object properties: id: @@ -36,4 +36,4 @@ get: content: application/json: schema: - $ref: '../components/schemas/4xx_response.yaml' \ No newline at end of file + $ref: '../components/schemas/4xx_response.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure.yaml index b4c0d9b7ddf79..dc2dc96e68eb4 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@configure.yaml @@ -9,7 +9,7 @@ get: tags: - cases parameters: - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' responses: '200': description: Indicates a successful call. @@ -17,7 +17,7 @@ get: application/json: schema: type: array - items: + items: type: object properties: $ref: '../components/schemas/case_configure_response_properties.yaml' @@ -35,7 +35,7 @@ post: summary: Add case settings operationId: setCaseConfigurationDefaultSpace description: > - Case settings include external connection details, custom fields, and templates. + Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. @@ -70,4 +70,4 @@ post: content: application/json: schema: - $ref: '../components/schemas/4xx_response.yaml' \ No newline at end of file + $ref: '../components/schemas/4xx_response.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml index 61a791073cd80..316835cbce5e8 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml @@ -9,7 +9,7 @@ get: tags: - cases parameters: - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' responses: '200': description: Indicates a successful call. @@ -34,4 +34,4 @@ get: content: application/json: schema: - $ref: '../components/schemas/4xx_response.yaml' \ No newline at end of file + $ref: '../components/schemas/4xx_response.yaml' diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@status.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@status.yaml index 13600ae78d9d1..d930c00b6dc72 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@status.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@status.yaml @@ -9,7 +9,7 @@ get: tags: - cases parameters: - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' responses: '200': description: Indicates a successful call. diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml index 0117a1461280b..575969bf8b54a 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml @@ -7,7 +7,7 @@ get: tags: - cases parameters: - - $ref: '../components/parameters/owner.yaml' + - $ref: '../components/parameters/owner_filter.yaml' responses: '200': description: Indicates a successful call. @@ -26,4 +26,4 @@ get: content: application/json: schema: - $ref: '../components/schemas/4xx_response.yaml' \ No newline at end of file + $ref: '../components/schemas/4xx_response.yaml'