Skip to content
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

Jump to bottom

[DOCS] Automate docs for get case APIs #144950

Merged
merged 9 commits into from
Nov 10, 2022
Merged

[DOCS] Automate docs for get case APIs #144950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
87d536b
[DOCS] Automate API output for get case tags
lcawl Nov 9, 2022
ac8d562
[DOCS] Automate API output for get comment
lcawl Nov 9, 2022
31bb3f8
[DOCS] Automate API output for get case status
lcawl Nov 9, 2022
0a04b4a
[DOCS] Automate API output for get case by alert
lcawl Nov 9, 2022
1254827
[DOCS] Automate API output for get cases
lcawl Nov 9, 2022
b62ee47
[DOCS] Automate API output for get reporters
lcawl Nov 9, 2022
4b24029
[DOCS] Generate API docs
lcawl Nov 9, 2022
bec9d74
[DOCS] Fix minor formatting issues
lcawl Nov 9, 2022
55ef6c2
Merge branch 'main' into get-cases
lcawl Nov 9, 2022
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
500 changes: 479 additions & 21 deletions docs/api-generated/cases/case-apis-passthru.asciidoc
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-get-case.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Returns information about 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>`
Expand Down
7 changes: 7 additions & 0 deletions docs/api/cases/cases-api-get-cases-by-alert.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ preview::[]

Returns the cases associated with a specific alert.

[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/alerts/<alert_id>`
Expand Down
7 changes: 7 additions & 0 deletions docs/api/cases/cases-api-get-reporters.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@

Returns information about the users who opened 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/reporters`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-get-status.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Returns the number of cases that are open, closed, and in progress.

[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>>.
====

deprecated::[8.1.0]

=== {api-request-title}
Expand Down
6 changes: 6 additions & 0 deletions docs/api/cases/cases-api-get-tags.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Aggregates and returns a list of case tags.

[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/tags`
Expand Down
Loading