github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.11] [OAS] Update tech preview text in case APIs (#170280) (#170323)

Browse source 
# Backport

This will backport the following commits from `main` to `8.11`:
- [[OAS] Update tech preview text in case APIs
(#170280)](https://github.com/elastic/kibana/pull/170280)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-11-01T15:20:55Z","message":"[OAS]
Update tech preview text in case APIs
(#170280)","sha":"87ad907be6409e076bb180a9b4b61f33d9ff71e4","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","backport:prev-minor","v8.12.0"],"number":170280,"url":"https://github.com/elastic/kibana/pull/170280","mergeCommit":{"message":"[OAS]
Update tech preview text in case APIs
(#170280)","sha":"87ad907be6409e076bb180a9b4b61f33d9ff71e4"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/170280","number":170280,"mergeCommit":{"message":"[OAS]
Update tech preview text in case APIs
(#170280)","sha":"87ad907be6409e076bb180a9b4b61f33d9ff71e4"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2023-11-01 12:48:25 -04:00 • committed by GitHub
parent bb04d1407d
commit 6524d6d02f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

6
x-pack/plugins/cases/docs/openapi/bundled.json
View file

@ -5549,7 +5549,7 @@
},
"alert_identifiers": {
"title": "Alert identifiers",
"description": "The alert identifiers. It is required only when `type` is `alert`. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "The alert identifiers. It is required only when `type` is `alert`. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. 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",
"oneOf": [
{
"type": "string"
@ -5567,7 +5567,7 @@
},
"alert_indices": {
"title": "Alert indices",
"description": "The alert indices. It is required only when `type` is `alert`. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "The alert indices. It is required only when `type` is `alert`. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array. 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",
"oneOf": [
{
"type": "string"
@ -5584,7 +5584,7 @@
},
"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 apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"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,
"properties": {

6
x-pack/plugins/cases/docs/openapi/bundled.yaml
View file

@ -3760,7 +3760,7 @@ components:
alert_identifiers:
title: Alert identifiers
description: |
The alert identifiers. It is required only when `type` is `alert`. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The alert identifiers. It is required only when `type` is `alert`. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. 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.
oneOf:
- type: string
- type: array
@ -3772,7 +3772,7 @@ components:
alert_indices:
title: Alert indices
description: |
The alert indices. It is required only when `type` is `alert`. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The alert indices. It is required only when `type` is `alert`. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array. 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.
oneOf:
- type: string
- type: array
@ -3783,7 +3783,7 @@ components:
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 apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
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
properties:

12
x-pack/plugins/cases/docs/openapi/components/schemas/alert_identifiers.yaml
View file

@ -1,11 +1,11 @@
title: Alert identifiers
description: >
The alert identifiers. It is required only when `type` is `alert`. You can use
an array of strings to add multiple alerts to a case, provided that they all
relate to the same rule; `index` must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended
rather than calling the API multiple times. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply
best effort to fix any issues, but features in technical preview are not
subject to the support SLA of official GA features.
The alert identifiers.
It is required only when `type` is `alert`.
You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; `index` must also be an array with the same length or number of elements.
Adding multiple alerts in this manner is recommended rather than calling the API multiple times.
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.
oneOf:
- type: string
- type: array

12
x-pack/plugins/cases/docs/openapi/components/schemas/alert_indices.yaml
View file

@ -1,12 +1,10 @@
title: Alert indices
description: >
The alert indices. It is required only when `type` is `alert`. If you are
adding multiple alerts to a case, use an array of strings; the position of
each index name in the array must match the position of the corresponding
alert identifier in the `alertId` array. This functionality is in technical
preview and may be changed or removed in a future release. Elastic will apply
best effort to fix any issues, but features in technical preview are not
subject to the support SLA of official GA features.
The alert indices.
It is required only when `type` is `alert`.
If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the `alertId` array.
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.
oneOf:
- type: string
- type: array

9
x-pack/plugins/cases/docs/openapi/components/schemas/rule.yaml
View file

@ -1,10 +1,9 @@
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 apply best effort to
fix any issues, but features in technical preview are not subject to the
support SLA of official GA features.
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
properties: