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

Add operationId to cases openAPI specs (#136161) (#136298)

Browse source 
(cherry picked from commit 92a516a25d)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2022-07-13 11:50:08 -04:00 • committed by GitHub
parent 088e6fc677
commit 2efa79a40b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 163 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -31,7 +31,8 @@
"paths": {
"/api/cases": {
"post": {
"summary": "Creates a case.",
"summary": "Creates a case in the default space.",
"operationId": "createCaseDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
"tags": [
"cases",
@ -484,7 +485,8 @@
]
},
"delete": {
"summary": "Deletes one or more cases.",
"summary": "Deletes one or more cases from the default space.",
"operationId": "deleteCaseDefaultSpace",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -517,7 +519,8 @@
]
},
"patch": {
"summary": "Updates one or more cases.",
"summary": "Updates one or more cases in the default space.",
"operationId": "updateCaseDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating.\n",
"tags": [
"cases",
@ -989,7 +992,8 @@
},
"/api/cases/_find": {
"get": {
"summary": "Retrieves a paginated subset of cases.",
"summary": "Retrieves a paginated subset of cases from the default space.",
"operationId": "getCasesDefaultSpace",
"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",
"tags": [
"cases",
@ -1494,7 +1498,8 @@
},
"/api/cases/alerts/{alertId}": {
"get": {
"summary": "Returns the cases associated with a specific alert.",
"summary": "Returns the cases associated with a specific alert in the default space.",
"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,
"tags": [
@ -1554,7 +1559,8 @@
},
"/api/cases/configure": {
"get": {
"summary": "Retrieves external connection details, such as the closure type and default connector for cases.",
"summary": "Retrieves external connection details, such as the closure type and default connector for cases in the default space.",
"operationId": "getCaseConfigurationDefaultSpace",
"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 case configuration.\n",
"tags": [
"cases",
@ -1762,7 +1768,8 @@
]
},
"post": {
"summary": "Sets external connection details, such as the closure type and default connector for cases.",
"summary": "Sets external connection details, such as the closure type and default connector for cases in the default space.",
"operationId": "setCaseConfigurationDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API. 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.\n",
"tags": [
"cases",
@ -2109,7 +2116,8 @@
},
"/api/cases/configure/{configurationId}": {
"patch": {
"summary": "Updates external connection details, such as the closure type and default connector for cases.",
"summary": "Updates external connection details, such as the closure type and default connector for cases in the default space.",
"operationId": "updateCaseConfigurationDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API.\n",
"tags": [
"cases",
@ -2445,7 +2453,8 @@
},
"/api/cases/configure/connectors/_find": {
"get": {
"summary": "Retrieves information about connectors.",
"summary": "Retrieves information about connectors for cases in the default space.",
"operationId": "getCaseConnectorsDefaultSpace",
"description": "In particular, only the connectors that are supported for use in cases are returned. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"cases",
@ -2520,7 +2529,8 @@
},
"/api/cases/reporters": {
"get": {
"summary": "Returns information about the users who opened cases.",
"summary": "Returns information about the users who opened cases in the default space.",
"operationId": "getCaseReportersDefaultCase",
"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. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.\n",
"tags": [
"cases",
@ -2630,7 +2640,8 @@
},
"/api/cases/tags": {
"get": {
"summary": "Aggregates and returns a list of case tags.",
"summary": "Aggregates and returns a list of case tags in the default space.",
"operationId": "getCaseTagsDefaultSpace",
"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",
"tags": [
"cases",
@ -2690,7 +2701,8 @@
},
"/api/cases/{caseId}/comments": {
"post": {
"summary": "Adds a comment or alert to a case.",
"summary": "Adds a comment or alert to a case in the default space.",
"operationId": "addCaseCommentDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
"tags": [
"cases",
@ -3016,7 +3028,8 @@
]
},
"delete": {
"summary": "Deletes all comments and alerts from a case.",
"summary": "Deletes all comments and alerts from a case in the default space.",
"operationId": "deleteCaseCommentsDefaultSpace",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -3042,7 +3055,8 @@
]
},
"patch": {
"summary": "Updates a comment or alert in a case.",
"summary": "Updates a comment or alert in a case in the default space.",
"operationId": "updateCaseCommentDefaultSpace",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
"tags": [
"cases",
@ -3368,7 +3382,8 @@
]
},
"get": {
"summary": "Retrieves all the comments from a case.",
"summary": "Retrieves all the comments from a case in the default space.",
"operationId": "getAllCaseCommentsDefaultSpace",
"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 with the comments you're seeking.\n",
"tags": [
"cases",
@ -3417,7 +3432,8 @@
},
"/api/cases/{caseId}/comments/{commentId}": {
"delete": {
"summary": "Deletes a comment or alert from a case.",
"summary": "Deletes a comment or alert from a case in the default space.",
"operationId": "deleteCaseCommentDefaultSpace",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -3446,7 +3462,8 @@
]
},
"get": {
"summary": "Retrieves a comment from a case.",
"summary": "Retrieves a comment from a case in the default space.",
"operationId": "getCaseCommentDefaultSpace",
"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 with the comments you're seeking.\n",
"tags": [
"cases",
@ -3499,6 +3516,7 @@
"/s/{spaceId}/api/cases": {
"post": {
"summary": "Creates a case.",
"operationId": "createCase",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
"tags": [
"cases",
@ -3955,6 +3973,7 @@
},
"delete": {
"summary": "Deletes one or more cases.",
"operationId": "deleteCase",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -3991,6 +4010,7 @@
},
"patch": {
"summary": "Updates one or more cases.",
"operationId": "updateCase",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating.\n",
"tags": [
"cases",
@ -4466,6 +4486,7 @@
"/s/{spaceId}/api/cases/_find": {
"get": {
"summary": "Retrieves a paginated subset of cases.",
"operationId": "getCases",
"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",
"tags": [
"cases",
@ -4972,6 +4993,7 @@
"/s/{spaceId}/api/cases/alerts/{alertId}": {
"get": {
"summary": "Returns the cases associated with a specific alert.",
"operationId": "getCasesByAlert",
"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,
"tags": [
@ -5035,6 +5057,7 @@
"/s/{spaceId}/api/cases/configure": {
"get": {
"summary": "Retrieves external connection details, such as the closure type and default connector for cases.",
"operationId": "getCaseConfiguration",
"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 case configuration.\n",
"tags": [
"cases",
@ -5246,6 +5269,7 @@
},
"post": {
"summary": "Sets external connection details, such as the closure type and default connector for cases.",
"operationId": "setCaseConfiguration",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API. 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.\n",
"tags": [
"cases",
@ -5596,6 +5620,7 @@
"/s/{spaceId}/api/cases/configure/{configurationId}": {
"patch": {
"summary": "Updates external connection details, such as the closure type and default connector for cases.",
"operationId": "updateCaseConfiguration",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API.\n",
"tags": [
"cases",
@ -5935,6 +5960,7 @@
"/s/{spaceId}/api/cases/configure/connectors/_find": {
"get": {
"summary": "Retrieves information about connectors.",
"operationId": "getCaseConnectors",
"description": "In particular, only the connectors that are supported for use in cases are returned. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"cases",
@ -6015,6 +6041,7 @@
"/s/{spaceId}/api/cases/reporters": {
"get": {
"summary": "Returns information about the users who opened cases.",
"operationId": "getCaseReporters",
"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. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.\n",
"tags": [
"cases",
@ -6131,6 +6158,7 @@
"/s/{spaceId}/api/cases/tags": {
"get": {
"summary": "Aggregates and returns a list of case tags.",
"operationId": "getCaseTags",
"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",
"tags": [
"cases",
@ -6194,6 +6222,7 @@
"/s/{spaceId}/api/cases/{caseId}/comments": {
"post": {
"summary": "Adds a comment or alert to a case.",
"operationId": "addCaseComment",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n",
"tags": [
"cases",
@ -6523,6 +6552,7 @@
},
"delete": {
"summary": "Deletes all comments and alerts from a case.",
"operationId": "deleteCaseComments",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -6552,6 +6582,7 @@
},
"patch": {
"summary": "Updates a comment or alert in a case.",
"operationId": "updateCaseComment",
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're updating. NOTE: You cannot change the comment type or the owner of a comment.\n",
"tags": [
"cases",
@ -6881,6 +6912,7 @@
},
"get": {
"summary": "Retrieves all the comments from a case.",
"operationId": "getAllCaseComments",
"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 with the comments you're seeking.\n",
"deprecated": true,
"tags": [
@ -6933,6 +6965,7 @@
"/s/{spaceId}/api/cases/{caseId}/comments/{commentId}": {
"delete": {
"summary": "Deletes a comment or alert from a case.",
"operationId": "deleteCaseComment",
"description": "You must have `all` 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 deleting.\n",
"tags": [
"cases",
@ -6965,6 +6998,7 @@
},
"get": {
"summary": "Retrieves a comment from a case.",
"operationId": "getCaseComment",
"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 with the comments you're seeking.\n",
"tags": [
"cases",

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

@ -19,7 +19,8 @@ servers:
paths:
/api/cases:
post:
summary: Creates a case.
summary: Creates a case in the default space.
operationId: createCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -411,7 +412,8 @@ paths:
servers:
- url: https://localhost:5601
delete:
summary: Deletes one or more cases.
summary: Deletes one or more cases from the default space.
operationId: deleteCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -436,7 +438,8 @@ paths:
servers:
- url: https://localhost:5601
patch:
summary: Updates one or more cases.
summary: Updates one or more cases in the default space.
operationId: updateCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -839,7 +842,8 @@ paths:
- url: https://localhost:5601
/api/cases/_find:
get:
summary: Retrieves a paginated subset of cases.
summary: Retrieves a paginated subset of cases from the default space.
operationId: getCasesDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -1230,7 +1234,8 @@ paths:
- url: https://localhost:5601
/api/cases/alerts/{alertId}:
get:
summary: Returns the cases associated with a specific alert.
summary: Returns the cases associated with a specific alert in the default space.
operationId: getCasesByAlertDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -1269,7 +1274,8 @@ paths:
get:
summary: >-
Retrieves external connection details, such as the closure type and
default connector for cases.
default connector for cases in the default space.
operationId: getCaseConfigurationDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -1455,7 +1461,8 @@ paths:
post:
summary: >-
Sets external connection details, such as the closure type and default
connector for cases.
connector for cases in the default space.
operationId: setCaseConfigurationDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -1776,7 +1783,8 @@ paths:
patch:
summary: >-
Updates external connection details, such as the closure type and
default connector for cases.
default connector for cases in the default space.
operationId: updateCaseConfigurationDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2086,7 +2094,8 @@ paths:
- url: https://localhost:5601
/api/cases/configure/connectors/_find:
get:
summary: Retrieves information about connectors.
summary: Retrieves information about connectors for cases in the default space.
operationId: getCaseConnectorsDefaultSpace
description: >
In particular, only the connectors that are supported for use in cases
are returned. You must have `read` privileges for the **Actions and
@ -2136,7 +2145,10 @@ paths:
- url: https://localhost:5601
/api/cases/reporters:
get:
summary: Returns information about the users who opened cases.
summary: >-
Returns information about the users who opened cases in the default
space.
operationId: getCaseReportersDefaultCase
description: >
You must have read privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2209,7 +2221,8 @@ paths:
- url: https://localhost:5601
/api/cases/tags:
get:
summary: Aggregates and returns a list of case tags.
summary: Aggregates and returns a list of case tags in the default space.
operationId: getCaseTagsDefaultSpace
description: >
You must have read privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2248,7 +2261,8 @@ paths:
- url: https://localhost:5601
/api/cases/{caseId}/comments:
post:
summary: Adds a comment or alert to a case.
summary: Adds a comment or alert to a case in the default space.
operationId: addCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2508,7 +2522,8 @@ paths:
servers:
- url: https://localhost:5601
delete:
summary: Deletes all comments and alerts from a case.
summary: Deletes all comments and alerts from a case in the default space.
operationId: deleteCaseCommentsDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2525,7 +2540,8 @@ paths:
servers:
- url: https://localhost:5601
patch:
summary: Updates a comment or alert in a case.
summary: Updates a comment or alert in a case in the default space.
operationId: updateCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2786,7 +2802,8 @@ paths:
servers:
- url: https://localhost:5601
get:
summary: Retrieves all the comments from a case.
summary: Retrieves all the comments from a case in the default space.
operationId: getAllCaseCommentsDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2816,7 +2833,8 @@ paths:
- url: https://localhost:5601
/api/cases/{caseId}/comments/{commentId}:
delete:
summary: Deletes a comment or alert from a case.
summary: Deletes a comment or alert from a case in the default space.
operationId: deleteCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2834,7 +2852,8 @@ paths:
servers:
- url: https://localhost:5601
get:
summary: Retrieves a comment from a case.
summary: Retrieves a comment from a case in the default space.
operationId: getCaseCommentDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -2865,6 +2884,7 @@ paths:
/s/{spaceId}/api/cases:
post:
summary: Creates a case.
operationId: createCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the
@ -3259,6 +3279,7 @@ paths:
- url: https://localhost:5601
delete:
summary: Deletes one or more cases.
operationId: deleteCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the
@ -3286,6 +3307,7 @@ paths:
- url: https://localhost:5601
patch:
summary: Updates one or more cases.
operationId: updateCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the
@ -3691,6 +3713,7 @@ paths:
/s/{spaceId}/api/cases/_find:
get:
summary: Retrieves a paginated subset of cases.
operationId: getCases
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -4085,6 +4108,7 @@ paths:
/s/{spaceId}/api/cases/alerts/{alertId}:
get:
summary: Returns the cases associated with a specific alert.
operationId: getCasesByAlert
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -4125,6 +4149,7 @@ paths:
summary: >-
Retrieves external connection details, such as the closure type and
default connector for cases.
operationId: getCaseConfiguration
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -4312,6 +4337,7 @@ paths:
summary: >-
Sets external connection details, such as the closure type and default
connector for cases.
operationId: setCaseConfiguration
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -4634,6 +4660,7 @@ paths:
summary: >-
Updates external connection details, such as the closure type and
default connector for cases.
operationId: updateCaseConfiguration
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -4945,6 +4972,7 @@ paths:
/s/{spaceId}/api/cases/configure/connectors/_find:
get:
summary: Retrieves information about connectors.
operationId: getCaseConnectors
description: >
In particular, only the connectors that are supported for use in cases
are returned. You must have `read` privileges for the **Actions and
@ -4997,6 +5025,7 @@ paths:
/s/{spaceId}/api/cases/reporters:
get:
summary: Returns information about the users who opened cases.
operationId: getCaseReporters
description: >
You must have read privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5072,6 +5101,7 @@ paths:
/s/{spaceId}/api/cases/tags:
get:
summary: Aggregates and returns a list of case tags.
operationId: getCaseTags
description: >
You must have read privileges for the **Cases*** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5112,6 +5142,7 @@ paths:
/s/{spaceId}/api/cases/{caseId}/comments:
post:
summary: Adds a comment or alert to a case.
operationId: addCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5373,6 +5404,7 @@ paths:
- url: https://localhost:5601
delete:
summary: Deletes all comments and alerts from a case.
operationId: deleteCaseComments
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5391,6 +5423,7 @@ paths:
- url: https://localhost:5601
patch:
summary: Updates a comment or alert in a case.
operationId: updateCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5653,6 +5686,7 @@ paths:
- url: https://localhost:5601
get:
summary: Retrieves all the comments from a case.
operationId: getAllCaseComments
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5684,6 +5718,7 @@ paths:
/s/{spaceId}/api/cases/{caseId}/comments/{commentId}:
delete:
summary: Deletes a comment or alert from a case.
operationId: deleteCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -5703,6 +5738,7 @@ paths:
- url: https://localhost:5601
get:
summary: Retrieves a comment from a case.
operationId: getCaseComment
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security*** section of the

7
x-pack/plugins/cases/docs/openapi/components/examples/get_status.yaml Normal file
View file

@ -0,0 +1,7 @@
summary: Get the number of cases in each state.
value:
{
"count_open_cases": 27,
"count_in_progress_cases": 50,
"count_closed_cases": 198
}

9
x-pack/plugins/cases/docs/openapi/paths/api@cases.yaml
View file

@ -1,5 +1,6 @@
post:
summary: Creates a case.
summary: Creates a case in the default space.
operationId: createCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -73,7 +74,8 @@ post:
- url: https://localhost:5601
delete:
summary: Deletes one or more cases.
summary: Deletes one or more cases from the default space.
operationId: deleteCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -97,7 +99,8 @@ delete:
- url: https://localhost:5601
patch:
summary: Updates one or more cases.
summary: Updates one or more cases in the default space.
operationId: updateCaseDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@_find.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves a paginated subset of cases.
summary: Retrieves a paginated subset of cases from the default space.
operationId: getCasesDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@alerts@{alertid}.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Returns the cases associated with a specific alert.
summary: Returns the cases associated with a specific alert in the default space.
operationId: getCasesByAlertDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

6
x-pack/plugins/cases/docs/openapi/paths/api@cases@configure.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves external connection details, such as the closure type and default connector for cases.
summary: Retrieves external connection details, such as the closure type and default connector for cases in the default space.
operationId: getCaseConfigurationDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -24,7 +25,8 @@ get:
- url: https://localhost:5601
post:
summary: Sets external connection details, such as the closure type and default connector for cases.
summary: Sets external connection details, such as the closure type and default connector for cases in the default space.
operationId: setCaseConfigurationDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@connectors@_find.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves information about connectors.
summary: Retrieves information about connectors for cases in the default space.
operationId: getCaseConnectorsDefaultSpace
description: >
In particular, only the connectors that are supported for use in cases are
returned. You must have `read` privileges for the **Actions and Connectors**

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@configure@{configurationid}.yaml
View file

@ -1,5 +1,6 @@
patch:
summary: Updates external connection details, such as the closure type and default connector for cases.
summary: Updates external connection details, such as the closure type and default connector for cases in the default space.
operationId: updateCaseConfigurationDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@reporters.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Returns information about the users who opened cases.
summary: Returns information about the users who opened cases in the default space.
operationId: getCaseReportersDefaultCase
description: >
You must have read privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,

3
x-pack/plugins/cases/docs/openapi/paths/api@cases@tags.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Aggregates and returns a list of case tags.
summary: Aggregates and returns a list of case tags in the default space.
operationId: getCaseTagsDefaultSpace
description: >
You must have read privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

12
x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments.yaml
View file

@ -1,5 +1,6 @@
post:
summary: Adds a comment or alert to a case.
summary: Adds a comment or alert to a case in the default space.
operationId: addCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -36,7 +37,8 @@ post:
- url: https://localhost:5601
delete:
summary: Deletes all comments and alerts from a case.
summary: Deletes all comments and alerts from a case in the default space.
operationId: deleteCaseCommentsDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -54,7 +56,8 @@ delete:
- url: https://localhost:5601
patch:
summary: Updates a comment or alert in a case.
summary: Updates a comment or alert in a case in the default space.
operationId: updateCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -92,7 +95,8 @@ patch:
- url: https://localhost:5601
get:
summary: Retrieves all the comments from a case.
summary: Retrieves all the comments from a case in the default space.
operationId: getAllCaseCommentsDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,

6
x-pack/plugins/cases/docs/openapi/paths/api@cases@{caseid}@comments@{commentid}.yaml
View file

@ -1,5 +1,6 @@
delete:
summary: Deletes a comment or alert from a case.
summary: Deletes a comment or alert from a case in the default space.
operationId: deleteCaseCommentDefaultSpace
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -18,7 +19,8 @@ delete:
- url: https://localhost:5601
get:
summary: Retrieves a comment from a case.
summary: Retrieves a comment from a case in the default space.
operationId: getCaseCommentDefaultSpace
description: >
You must have `read` privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,

3
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases.yaml
View file

@ -1,5 +1,6 @@
post:
summary: Creates a case.
operationId: createCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -75,6 +76,7 @@ post:
delete:
summary: Deletes one or more cases.
operationId: deleteCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -100,6 +102,7 @@ delete:
patch:
summary: Updates one or more cases.
operationId: updateCase
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

1
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves a paginated subset of cases.
operationId: getCases
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

1
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Returns the cases associated with a specific alert.
operationId: getCasesByAlert
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

2
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves external connection details, such as the closure type and default connector for cases.
operationId: getCaseConfiguration
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -26,6 +27,7 @@ get:
post:
summary: Sets external connection details, such as the closure type and default connector for cases.
operationId: setCaseConfiguration
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

3
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Retrieves information about connectors.
summary: Retrieves information about connectors.
operationId: getCaseConnectors
description: >
In particular, only the connectors that are supported for use in cases are
returned. You must have `read` privileges for the **Actions and Connectors**

1
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@{configurationid}.yaml
View file

@ -1,5 +1,6 @@
patch:
summary: Updates external connection details, such as the closure type and default connector for cases.
operationId: updateCaseConfiguration
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

1
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@reporters.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Returns information about the users who opened cases.
operationId: getCaseReporters
description: >
You must have read privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,

1
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@tags.yaml
View file

@ -1,5 +1,6 @@
get:
summary: Aggregates and returns a list of case tags.
operationId: getCaseTags
description: >
You must have read privileges for the **Cases*** feature in the
**Management**, **Observability**, or **Security** section of the Kibana

4
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments.yaml
View file

@ -1,5 +1,6 @@
post:
summary: Adds a comment or alert to a case.
operationId: addCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -38,6 +39,7 @@ post:
delete:
summary: Deletes all comments and alerts from a case.
operationId: deleteCaseComments
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -57,6 +59,7 @@ delete:
patch:
summary: Updates a comment or alert in a case.
operationId: updateCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -96,6 +99,7 @@ patch:
get:
summary: Retrieves all the comments from a case.
operationId: getAllCaseComments
description: >
You must have `read` privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security** section of the Kibana feature privileges,

2
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml
View file

@ -1,5 +1,6 @@
delete:
summary: Deletes a comment or alert from a case.
operationId: deleteCaseComment
description: >
You must have `all` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
@ -20,6 +21,7 @@ delete:
get:
summary: Retrieves a comment from a case.
operationId: getCaseComment
description: >
You must have `read` privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security*** section of the Kibana feature privileges,