kibana/x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml
Lisa Cawley c2185cec1d
[8.x] [DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs (#195325) (#199895)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS][OpenAPI] Change x-technical-preview to x-state in case APIs
(#195325)](https://github.com/elastic/kibana/pull/195325)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-10-17T23:14:34Z","message":"[DOCS][OpenAPI]
Change x-technical-preview to x-state in case APIs
(#195325)","sha":"7b106f7235e014563ed90721791d6516a9287d3f","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport:skip","v9.0.0","docs","Feature:Cases","v8.16.0","v8.17.0"],"number":195325,"url":"https://github.com/elastic/kibana/pull/195325","mergeCommit":{"message":"[DOCS][OpenAPI]
Change x-technical-preview to x-state in case APIs
(#195325)","sha":"7b106f7235e014563ed90721791d6516a9287d3f"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195325","number":195325,"mergeCommit":{"message":"[DOCS][OpenAPI]
Change x-technical-preview to x-state in case APIs
(#195325)","sha":"7b106f7235e014563ed90721791d6516a9287d3f"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
2024-11-14 11:30:50 -05:00

39 lines
1.2 KiB
YAML

get:
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.
x-state: Technical preview
tags:
- cases
parameters:
- $ref: ../components/parameters/alert_id.yaml
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: array
maxItems: 10000
items:
type: object
properties:
id:
type: string
description: The case identifier.
title:
type: string
description: The case title.
example:
- id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
title: security_case
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'