Skip to content

Commit

Permalink
[DOCS] Automate final case APIs (#145007)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Nov 15, 2022
1 parent 8974e82 commit 5348e39
Show file tree
Hide file tree
Showing 25 changed files with 3,566 additions and 11,749 deletions.
719 changes: 676 additions & 43 deletions docs/api-generated/cases/case-apis-passthru.asciidoc

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-find-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Retrieves a paginated subset of cases.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
====

=== {api-request-title}

`GET <kibana host>:<port>/api/cases/_find`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-find-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ In particular, only the connectors that are supported for use in cases are
returned. Refer to the list of supported external incident management systems in
<<add-case-connectors>>.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
====

=== {api-request-title}

`GET <kibana host>:<port>/api/cases/configure/connectors/_find`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-get-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ preview::[]

Gets all alerts attached to a case.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
====

=== {api-request-title}

`GET <kibana host>:<port>/api/cases/<case_id>/alerts`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-get-case-activity.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Returns all user activity for a case.

deprecated::[8.1.0]

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
====

=== {api-request-title}

`GET <kibana host>:<port>/api/cases/<case ID>/user_actions`
Expand Down
Loading

0 comments on commit 5348e39

Please sign in to comment.