From 0886b00e7768dbf695fc6a4209eeed00103455c3 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 17 Oct 2024 16:14:34 -0700 Subject: [PATCH] [DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs (#195325) (cherry picked from commit 7b106f7235e014563ed90721791d6516a9287d3f) --- oas_docs/output/kibana.yaml | 14 +++++++------- x-pack/plugins/cases/docs/openapi/bundled.json | 14 +++++++------- x-pack/plugins/cases/docs/openapi/bundled.yaml | 14 +++++++------- .../components/schemas/alert_identifiers.yaml | 2 +- .../openapi/components/schemas/alert_indices.yaml | 2 +- .../docs/openapi/components/schemas/rule.yaml | 2 +- .../docs/openapi/components/schemas/templates.yaml | 4 ++-- .../openapi/paths/api@cases@alerts@{alertid}.yaml | 2 +- .../openapi/paths/api@cases@{caseid}@alerts.yaml | 2 +- 9 files changed, 28 insertions(+), 28 deletions(-) diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 8ce8662ebd125..2efadba213d82 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -7452,7 +7452,7 @@ paths: summary: Get all alerts for a case tags: - cases - x-technical-preview: true + x-state: Technical preview '/api/cases/{caseId}/comments': delete: description: > @@ -7820,7 +7820,7 @@ paths: summary: Get cases for an alert tags: - cases - x-technical-preview: true + x-state: Technical preview /api/cases/configure: get: description: > @@ -27276,7 +27276,7 @@ components: maxItems: 1000 type: array title: Alert identifiers - x-technical-preview: true + x-state: Technical preview Cases_alert_indices: description: > The alert indices. It is required only when `type` is `alert`. If you @@ -27294,7 +27294,7 @@ components: maxItems: 1000 type: array title: Alert indices - x-technical-preview: true + x-state: Technical preview Cases_alert_response_properties: type: object properties: @@ -28432,7 +28432,7 @@ components: description: The rule name. example: security_rule type: string - x-technical-preview: true + x-state: Technical preview Cases_searchFieldsType: description: The fields to perform the `simple_query_string` parsed query against. enum: @@ -28625,7 +28625,7 @@ components: - type: string - type: boolean type: array - x-technical-preview: true + x-state: Technical preview description: $ref: '#/components/schemas/Cases_case_description' settings: @@ -28651,7 +28651,7 @@ components: tags: $ref: '#/components/schemas/Cases_template_tags' type: array - x-technical-preview: true + x-state: Technical preview Cases_update_alert_comment_request_properties: description: Defines properties for case comment requests when type is alert. type: object diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json index 659ab18aab155..6b84ab8e090fa 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.json +++ b/x-pack/plugins/cases/docs/openapi/bundled.json @@ -288,7 +288,7 @@ "summary": "Get cases for an alert", "operationId": "getCasesByAlertDefaultSpace", "description": "You must have `read` 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 seeking.\n", - "x-technical-preview": true, + "x-state": "Technical preview", "tags": [ "cases" ], @@ -1264,7 +1264,7 @@ "get": { "summary": "Get all alerts for a case", "description": "You must have `read` 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 seeking.\n", - "x-technical-preview": true, + "x-state": "Technical preview", "operationId": "getCaseAlertsDefaultSpace", "tags": [ "cases" @@ -3573,7 +3573,7 @@ }, "templates": { "type": "array", - "x-technical-preview": true, + "x-state": "Technical preview", "items": { "type": "object", "properties": { @@ -3611,7 +3611,7 @@ }, "customFields": { "type": "array", - "x-technical-preview": true, + "x-state": "Technical preview", "description": "Custom field values in the template.", "items": { "type": "object", @@ -3976,7 +3976,7 @@ "maxItems": 1000 } ], - "x-technical-preview": true, + "x-state": "Technical preview", "example": "6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42" }, "alert_indices": { @@ -3994,13 +3994,13 @@ "maxItems": 1000 } ], - "x-technical-preview": true + "x-state": "Technical preview" }, "rule": { "title": "Alerting rule", "description": "The rule that is associated with the alerts. It is required only when `type` is `alert`. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n", "type": "object", - "x-technical-preview": true, + "x-state": "Technical preview", "properties": { "id": { "description": "The rule identifier.", diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml index db2a7960614d9..40c86d41e1b26 100644 --- a/x-pack/plugins/cases/docs/openapi/bundled.yaml +++ b/x-pack/plugins/cases/docs/openapi/bundled.yaml @@ -168,7 +168,7 @@ paths: operationId: getCasesByAlertDefaultSpace description: | You must have `read` 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 seeking. - x-technical-preview: true + x-state: Technical preview tags: - cases parameters: @@ -844,7 +844,7 @@ paths: summary: Get all alerts for a case description: | You must have `read` 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 seeking. - x-technical-preview: true + x-state: Technical preview operationId: getCaseAlertsDefaultSpace tags: - cases @@ -2468,7 +2468,7 @@ components: maxLength: 256 templates: type: array - x-technical-preview: true + x-state: Technical preview items: type: object properties: @@ -2498,7 +2498,7 @@ components: $ref: '#/components/schemas/connector_types' customFields: type: array - x-technical-preview: true + x-state: Technical preview description: Custom field values in the template. items: type: object @@ -2765,7 +2765,7 @@ components: items: type: string maxItems: 1000 - x-technical-preview: true + x-state: Technical preview example: 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42 alert_indices: title: Alert indices @@ -2777,13 +2777,13 @@ components: items: type: string maxItems: 1000 - x-technical-preview: true + x-state: Technical preview rule: title: Alerting rule description: | The rule that is associated with the alerts. It is required only when `type` is `alert`. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. type: object - x-technical-preview: true + x-state: Technical preview properties: id: description: The rule identifier. diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml index cca8eb74f5019..3c60cb395a4c1 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml @@ -12,5 +12,5 @@ oneOf: items: type: string maxItems: 1000 -x-technical-preview: true +x-state: Technical preview example: 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42 \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml index 5c741e9601c44..9674e7bcf1eab 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml @@ -11,4 +11,4 @@ oneOf: items: type: string maxItems: 1000 -x-technical-preview: true \ No newline at end of file +x-state: Technical preview \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml index 09712b57ce138..6eb50e6adda42 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml @@ -5,7 +5,7 @@ description: > This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. type: object -x-technical-preview: true +x-state: Technical preview properties: id: description: The rule identifier. diff --git a/x-pack/plugins/cases/docs/openapi/components/schemas/templates.yaml b/x-pack/plugins/cases/docs/openapi/components/schemas/templates.yaml index b01cf5ad1f34e..ae82bfa2ed144 100644 --- a/x-pack/plugins/cases/docs/openapi/components/schemas/templates.yaml +++ b/x-pack/plugins/cases/docs/openapi/components/schemas/templates.yaml @@ -1,5 +1,5 @@ type: array -x-technical-preview: true +x-state: Technical preview items: type: object properties: @@ -16,7 +16,7 @@ items: $ref: 'case_configure_connector_properties.yaml' customFields: type: array - x-technical-preview: true + x-state: Technical preview description: Custom field values in the template. items: type: object 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 cef35ea078520..5175d5e4f9d7c 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 @@ -5,7 +5,7 @@ get: You must have `read` 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 seeking. - x-technical-preview: true + x-state: Technical preview tags: - cases parameters: diff --git a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@alerts.yaml b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@alerts.yaml index cbf4803df681a..584f9ed8aa7d6 100644 --- a/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@alerts.yaml +++ b/x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@alerts.yaml @@ -4,7 +4,7 @@ get: You must have `read` 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 seeking. - x-technical-preview: true + x-state: Technical preview operationId: getCaseAlertsDefaultSpace tags: - cases