Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs #195325

Merged
merged 5 commits into from
Oct 17, 2024
Merged

[DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs #195325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c795907
[DOCS[OpenAPI] Change x-technical-preview to x-state in case APIs
lcawl Oct 7, 2024
3eba823
Regenerate output
lcawl Oct 7, 2024
651c1cd
Merge branch 'main' into x-state
lcawl Oct 17, 2024
e76e538
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 17, 2024
fa73561
Merge branch 'main' into x-state
lcawl Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions oas_docs/output/kibana.staging.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7170,7 +7170,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: >
Expand Down Expand Up @@ -7538,7 +7538,7 @@ paths:
summary: Get cases for an alert
tags:
- cases
x-technical-preview: true
x-state: Technical preview
/api/cases/configure:
get:
description: >
Expand Down Expand Up @@ -46330,7 +46330,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
Expand All @@ -46348,7 +46348,7 @@ components:
maxItems: 1000
type: array
title: Alert indices
x-technical-preview: true
x-state: Technical preview
Cases_alert_response_properties:
type: object
properties:
Expand Down Expand Up @@ -47486,7 +47486,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:
Expand Down Expand Up @@ -47679,7 +47679,7 @@ components:
- type: string
- type: boolean
type: array
x-technical-preview: true
x-state: Technical preview
description:
$ref: '#/components/schemas/Cases_case_description'
settings:
Expand All @@ -47705,7 +47705,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
Expand Down
14 changes: 7 additions & 7 deletions oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7170,7 +7170,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: >
Expand Down Expand Up @@ -7538,7 +7538,7 @@ paths:
summary: Get cases for an alert
tags:
- cases
x-technical-preview: true
x-state: Technical preview
/api/cases/configure:
get:
description: >
Expand Down Expand Up @@ -46330,7 +46330,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
Expand All @@ -46348,7 +46348,7 @@ components:
maxItems: 1000
type: array
title: Alert indices
x-technical-preview: true
x-state: Technical preview
Cases_alert_response_properties:
type: object
properties:
Expand Down Expand Up @@ -47486,7 +47486,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:
Expand Down Expand Up @@ -47679,7 +47679,7 @@ components:
- type: string
- type: boolean
type: array
x-technical-preview: true
x-state: Technical preview
description:
$ref: '#/components/schemas/Cases_case_description'
settings:
Expand All @@ -47705,7 +47705,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
Expand Down
14 changes: 7 additions & 7 deletions x-pack/plugins/cases/docs/openapi/bundled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -3573,7 +3573,7 @@
},
"templates": {
"type": "array",
"x-technical-preview": true,
"x-state": "Technical preview",
"items": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -3976,7 +3976,7 @@
"maxItems": 1000
}
],
"x-technical-preview": true,
"x-state": "Technical preview",
"example": "6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42"
},
"alert_indices": {
Expand All @@ -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.",
Expand Down
14 changes: 7 additions & 7 deletions x-pack/plugins/cases/docs/openapi/bundled.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -2468,7 +2468,7 @@ components:
maxLength: 256
templates:
type: array
x-technical-preview: true
x-state: Technical preview
items:
type: object
properties:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ oneOf:
items:
type: string
maxItems: 1000
x-technical-preview: true
x-state: Technical preview
example: 6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ oneOf:
items:
type: string
maxItems: 1000
x-technical-preview: true
x-state: Technical preview
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/cases/docs/openapi/components/schemas/templates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
type: array
x-technical-preview: true
x-state: Technical preview
items:
type: object
properties:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@alerts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down