Commit graph

13 commits

Author SHA1 Message Date
Lisa Cawley
b75b272a88
[DOCS] Add deprecation details to case APIs (#152033) 2023-02-28 18:17:02 +01:00
Lisa Cawley
502fb009cf
[DOCS] Lint case API specifications (#149641) 2023-01-31 12:01:00 -08:00
Jonathan Buttner
a78fece18b
[Cases] Adding _find API for user actions (#148861)
This PR adds a new find API for retrieving a subset of the user actions
for a case.

Issue: https://github.com/elastic/kibana/issues/134344

```
GET /api/cases/<case_id>/user_actions/_find
Query Paramaters
{
  types?: Array of "assignees" | "comment" | "connector" | "description" | "pushed" | "tags" | "title" | "status" | "settings" | "severity" | "create_case" | "delete_case" | "action" | "alert" | "user" | "attachment"
  sortOrder?: "asc" | "desc"
  page?: number as a string
  perPage?: number as a string
}
```

<details><summary>Example request and response</summary>

Request
```
curl --location --request GET 'http://localhost:5601/api/cases/8df5fe00-96b1-11ed-9341-471c9630b5ec/user_actions/_find?types=create_case&sortOrder=asc' \
--header 'kbn-xsrf: hello' \
--header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ==' \
--data-raw ''
```


Response
```
{
    "userActions": [
        {
            "created_at": "2023-01-17T21:54:45.527Z",
            "created_by": {
                "username": "elastic",
                "full_name": null,
                "email": null,
                "profile_uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"
            },
            "owner": "cases",
            "action": "create",
            "payload": {
                "title": "Awesome case",
                "tags": [],
                "severity": "low",
                "description": "super",
                "assignees": [],
                "connector": {
                    "name": "none",
                    "type": ".none",
                    "fields": null,
                    "id": "none"
                },
                "settings": {
                    "syncAlerts": false
                },
                "owner": "cases",
                "status": "open"
            },
            "type": "create_case",
            "id": "8e121180-96b1-11ed-9341-471c9630b5ec",
            "case_id": "8df5fe00-96b1-11ed-9341-471c9630b5ec",
            "comment_id": null
        }
    ],
    "page": 1,
    "perPage": 20,
    "total": 1
}
```

</details>

## Notable Changes
- Created the new `_find` route
- Created a new `UserActionFinder` class and moved the find* methods
from the `index.ts` file into there as well as the new find logic
- Extracted the transform logic to its own file since its shared between
multiple files now
- Extracted the user action related integration test functions to the
`user_action.ts` utility file

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2023-01-23 13:25:41 -05:00
Lisa Cawley
9e837b80dc
[DOCS] Add 401 responses to case API specifications (#148857) 2023-01-17 09:20:51 -07:00
Lisa Cawley
e1227a3fe9
[DOCS] Add assignees query parameter to find cases API (#146087) 2022-11-29 08:46:49 -08:00
Lisa Cawley
876f1b9ac8
[DOCS] Alert limit for cases (#145950) 2022-11-24 17:56:45 +01:00
Lisa Cawley
74198264e1
[DOCS] Clarify alertId and index in add comment API (#145189) 2022-11-18 17:56:37 +01:00
Lisa Cawley
5348e39a36
[DOCS] Automate final case APIs (#145007) 2022-11-14 19:19:40 -07:00
Lisa Cawley
6804cffc5f
[DOCS] Automate docs for get case APIs (#144950) 2022-11-10 08:27:33 -08:00
Lisa Cawley
9bf262dd1c
[DOCS] Automate docs for push case and case case config APIs (#144657) 2022-11-08 09:34:52 -08:00
Lisa Cawley
6eb02d096f
[DOCS] Add assignees to case APIs (#143610) 2022-10-20 11:32:10 -07:00
Lisa Cawley
f92c76c86f
[DOCS] Automate docs for create/update/delete case APIs (#142929) 2022-10-18 16:09:57 -07:00
Lisa Cawley
2d8b29ed5a
[DOCS] Automate output for 4 case APIs (#142173) 2022-10-05 09:24:04 -07:00