Skip to content

Commit 5348e39

Browse files
lcawllcawl
authored
[DOCS] Automate final case APIs (#145007)
1 parent 8974e82 commit 5348e39

25 files changed

Lines changed: 3566 additions & 11749 deletions

‎docs/api-generated/cases/case-apis-passthru.asciidoc‎

Lines changed: 676 additions & 43 deletions
Large diffs are not rendered by default.

‎docs/api/cases/cases-api-find-cases.asciidoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
Retrieves a paginated subset of cases.
88

9+
[NOTE]
10+
====
11+
For the most up-to-date API details, refer to the
12+
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
13+
====
14+
915
=== {api-request-title}
1016

1117
`GET <kibana host>:<port>/api/cases/_find`

‎docs/api/cases/cases-api-find-connectors.asciidoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ In particular, only the connectors that are supported for use in cases are
1010
returned. Refer to the list of supported external incident management systems in
1111
<<add-case-connectors>>.
1212

13+
[NOTE]
14+
====
15+
For the most up-to-date API details, refer to the
16+
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
17+
====
18+
1319
=== {api-request-title}
1420

1521
`GET <kibana host>:<port>/api/cases/configure/connectors/_find`

‎docs/api/cases/cases-api-get-alerts.asciidoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ preview::[]
88

99
Gets all alerts attached to a case.
1010

11+
[NOTE]
12+
====
13+
For the most up-to-date API details, refer to the
14+
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
15+
====
16+
1117
=== {api-request-title}
1218

1319
`GET <kibana host>:<port>/api/cases/<case_id>/alerts`

‎docs/api/cases/cases-api-get-case-activity.asciidoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ Returns all user activity for a case.
88

99
deprecated::[8.1.0]
1010

11+
[NOTE]
12+
====
13+
For the most up-to-date API details, refer to the
14+
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
15+
====
16+
1117
=== {api-request-title}
1218

1319
`GET <kibana host>:<port>/api/cases/<case ID>/user_actions`

0 commit comments

Comments
 (0)