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

Add openAPI specifications for cases configure endpoint (#133265)

Browse source
This commit is contained in:
Lisa Cawley 2022-06-02 08:47:24 -07:00 • committed by GitHub
parent db3b271efb
commit 2d7a77448e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 4393 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/cases/cases-api-get-cases-by-alert.asciidoc
View file

@ -61,12 +61,8 @@ For example:
--------------------------------------------------
[
{
"id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
"title": "Case 1"
},
{
"id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2",
"title": "Case 2"
"id": "06116b80-e1c3-11ec-be9b-9b1838238ee6",
"title":"security_case"
}
]
--------------------------------------------------

14
docs/api/cases/cases-api-get-configuration.asciidoc
View file

@ -44,7 +44,7 @@ read.
[source,sh]
--------------------------------------------------
GET api/cases/configure?owner=securitySolution
GET api/cases/configure?owner=cases
--------------------------------------------------
// KIBANA
@ -54,19 +54,19 @@ The API returns the following type of information:
--------------------------------------------------
[
{
"owner": "securitySolution",
"closure_type": "close-by-user",
"created_at": "2020-03-30T13:31:38.083Z",
"owner": "cases",
"created_at": "2022-06-01T17:07:17.767Z",
"created_by": {
"email": "admin@hms.gov.uk",
"full_name": "Mr Admin",
"username": "admin"
"email": "null",
"full_name": "null",
"username": "elastic"
},
"updated_at": null,
"updated_by": null,
"connector": {
"id": "131d4448-abe0-4789-939d-8ef60680b498",
"name": "my-jira",
"name": "my-jira-connector",
"type": ".jira",
"fields": null
},

44
docs/api/cases/cases-api-set-configuration.asciidoc
View file

@ -109,9 +109,9 @@ POST api/cases/configure
{
"owner": "cases",
"connector": {
"id": "131d4448-abe0-4789-939d-8ef60680b498",
"name": "my-serviceNow",
"type": ".servicenow",
"id": "5e656730-e1ca-11ec-be9b-9b1838238ee6",
"name": "my-jira-connector",
"type": ".jira",
"fields": null,
},
"closure_type": "close-by-user"
@ -123,41 +123,41 @@ The API returns the following response:
[source,json]
--------------------------------------------------
{
"owner": "cases",
"closure_type": "close-by-user",
"created_at": "2022-04-02T01:09:02.303Z",
"owner": "cases",
"created_at": "2022-06-01T17:07:17.767Z",
"created_by": {
"email": "moneypenny@hms.gov.uk",
"full_name": "Ms Moneypenny",
"username": "moneypenny"
"username": "elastic",
"email": null,
"full_name": null
},
"updated_at": null,
"updated_by": null,
"connector": {
"id": "131d4448-abe0-4789-939d-8ef60680b498",
"name": "my-serviceNow",
"type": ".servicenow",
"fields": null,
"id": "5e656730-e1ca-11ec-be9b-9b1838238ee6",
"name": "my-jira-connector",
"type": ".jira",
"fields": null
},
"mappings": [
{
"source": "title",
"target": "short_description",
"source": "title",
"target": "summary",
"action_type": "overwrite"
},
{
"source":"description",
"target":"description",
"action_type":"overwrite"
"source": "description",
"target": "description",
"action_type": "overwrite"
},
{
"source":"comments",
"target":"work_notes",
"action_type":"append"
"source": "comments",
"target": "comments",
"action_type": "append"
}
],
"version": "WzE3NywxXQ==",
"version": "WzIwNzMsMV0=",
"error": null,
"id": "7349772f-421a-4de3-b8bb-2d9b22ccee30",
"id": "4a97a440-e1cd-11ec-be9b-9b1838238ee6"
}
--------------------------------------------------

18
docs/api/cases/cases-api-update-configuration.asciidoc
View file

@ -101,19 +101,19 @@ The API returns the following:
[source,json]
--------------------------------------------------
{
"closure_type": "close-by-user",
"closure_type": "close-by-pushing",
"owner": "cases",
"created_at": "2022-04-06T20:57:40.746Z",
"created_at": "2022-06-01T17:07:17.767Z",
"created_by": {
"email": "admin@hms.gov.uk",
"full_name": "Ms Admin",
"username": "admin"
"email": "null",
"full_name": "null",
"username": "elastic"
},
"updated_at": "2022-04-12T22:41:09.262Z",
"updated_at": "2022-06-01T19:58:48.169Z",
"updated_by": {
"email": "admin@hms.gov.uk",
"full_name": "Ms Admin",
"username": "admin"
"email": "null",
"full_name": "null",
"username": "elastic"
},
"connector": {
"id": "none",