Skip to content

[8.7] [DOCS] Add deprecation details to case APIs (#152033) #152371

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

Merged
kibanamachine merged 2 commits into from
Mar 1, 2023
Merged

[8.7] [DOCS] Add deprecation details to case APIs (#152033) #152371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5305caf
[DOCS] Add deprecation details to case APIs (#152033)
lcawl Feb 28, 2023
6fc6402
Merge branch '8.7' into backport/8.7/pr-152033
lcawl Feb 28, 2023
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
670 changes: 335 additions & 335 deletions docs/api-generated/cases/case-apis-passthru.asciidoc
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 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 @@ -209,7 +209,7 @@
"/s/{spaceId}/api/cases/_find": {
"get": {
"summary": "Retrieves a paginated subset of cases.",
"operationId": "getCases",
"operationId": "findCases",
"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"
Expand Down Expand Up @@ -1201,7 +1201,7 @@
"/s/{spaceId}/api/cases/configure/connectors/_find": {
"get": {
"summary": "Retrieves information about connectors.",
"operationId": "getCaseConnectors",
"operationId": "findCaseConnectors",
"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"
Expand Down Expand Up @@ -1371,7 +1371,7 @@
"get": {
"summary": "Returns the number of cases that are open, closed, and in progress.",
"operationId": "getCaseStatus",
"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",
"description": "Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find cases API instead. 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",
"deprecated": true,
"tags": [
"cases"
Expand Down Expand Up @@ -1525,7 +1525,7 @@
{
"in": "query",
"name": "includeComments",
"description": "Determines whether case comments are returned.",
"description": "Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.",
"deprecated": true,
"schema": {
"type": "boolean",
Expand Down Expand Up @@ -1806,7 +1806,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",
"description": "Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; instead, use the get case comment API, which requires a comment identifier in the path. 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": [
"cases"
Expand Down Expand Up @@ -2034,7 +2034,7 @@
"/s/{spaceId}/api/cases/{caseId}/user_actions": {
"get": {
"summary": "Returns all user activity 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 case you're seeking.\n",
"description": "Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find user actions API instead. 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 you're seeking.\n",
"deprecated": true,
"operationId": "getCaseActivity",
"tags": [
Expand Down
12 changes: 6 additions & 6 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 @@ -124,7 +124,7 @@ paths:
/s/{spaceId}/api/cases/_find:
get:
summary: Retrieves a paginated subset of cases.
operationId: getCases
operationId: findCases
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.
tags:
Expand Down Expand Up @@ -783,7 +783,7 @@ paths:
/s/{spaceId}/api/cases/configure/connectors/_find:
get:
summary: Retrieves information about connectors.
operationId: getCaseConnectors
operationId: findCaseConnectors
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.
tags:
Expand Down Expand Up @@ -889,7 +889,7 @@ paths:
summary: Returns the number of cases that are open, closed, and in progress.
operationId: getCaseStatus
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.
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find cases API instead. 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.
deprecated: true
tags:
- cases
Expand Down Expand Up @@ -977,7 +977,7 @@ paths:
- $ref: '#/components/parameters/space_id'
- in: query
name: includeComments
description: Determines whether case comments are returned.
description: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.
deprecated: true
schema:
type: boolean
Expand Down Expand Up @@ -1139,7 +1139,7 @@ paths:
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.
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; instead, use the get case comment API, which requires a comment identifier in the path. 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.
deprecated: true
tags:
- cases
Expand Down Expand Up @@ -1263,7 +1263,7 @@ paths:
get:
summary: Returns all user activity 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 case you're seeking.
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find user actions API instead. 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 you're seeking.
deprecated: true
operationId: getCaseActivity
tags:
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
summary: Retrieves a paginated subset of cases.
operationId: getCases
operationId: findCases
description: >
You must have `read` privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
Expand Down
2 changes: 1 addition & 1 deletion ...ck/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
summary: Retrieves information about connectors.
operationId: getCaseConnectors
operationId: findCaseConnectors
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**
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@status.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ get:
summary: Returns the number of cases that are open, closed, and in progress.
operationId: getCaseStatus
description: >
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find cases API instead.
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.
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ get:
- $ref: '../components/parameters/space_id.yaml'
- in: query
name: includeComments
description: Determines whether case comments are returned.
description: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.
deprecated: true
schema:
type: boolean
Expand Down
2 changes: 2 additions & 0 deletions x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ get:
summary: Retrieves all the comments from a case.
operationId: getAllCaseComments
description: >
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release;
instead, use the get case comment API, which requires a comment identifier in the path.
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.
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
get:
summary: Returns all user activity for a case.
description: >
Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find user actions API instead.
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 you're seeking.
Expand Down