github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.7] [DOCS] Add stub for find case activity API (#152041) (#152370)

Browse source 
# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Add stub for find case activity API
(#152041)](https://github.com/elastic/kibana/pull/152041)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-02-28T17:16:33Z","message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","backport:prev-minor","v8.7.0","v8.8.0"],"number":152041,"url":"https://github.com/elastic/kibana/pull/152041","mergeCommit":{"message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152041","number":152041,"mergeCommit":{"message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2023-02-28 12:41:53 -05:00 • committed by GitHub
parent 89d70c5b82
commit 106c835524
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/cases.asciidoc
View file

@ -8,6 +8,7 @@ these APIs:
* <<cases-api-create>>
* <<cases-api-delete-cases>>
* <<cases-api-delete-comments>>
* <<cases-api-find-case-activity>>
* <<cases-api-find-cases>>
* <<cases-api-find-connectors>>
* <<cases-api-get-alerts>>
@ -33,6 +34,7 @@ include::cases/cases-api-create.asciidoc[leveloffset=+1]
include::cases/cases-api-delete-cases.asciidoc[leveloffset=+1]
include::cases/cases-api-delete-comments.asciidoc[leveloffset=+1]
//FIND
include::cases/cases-api-find-case-activity.asciidoc[leveloffset=+1]
include::cases/cases-api-find-cases.asciidoc[leveloffset=+1]
include::cases/cases-api-find-connectors.asciidoc[leveloffset=+1]
//GET

20
docs/api/cases/cases-api-find-case-activity.asciidoc Normal file
View file

@ -0,0 +1,20 @@
[[cases-api-find-case-activity]]
== Find case activity API
++++
<titleabbrev>Find case activity</titleabbrev>
++++
Finds user activity for 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>/user_actions/_find`
`GET <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/user_actions/_find`

2
docs/api/cases/cases-api-get-case-activity.asciidoc
View file

@ -6,7 +6,7 @@
Returns all user activity for a case.
deprecated::[8.1.0]
deprecated::[8.1.0,Use <<cases-api-find-case-activity>> instead.]
[NOTE]
====