Skip to content

Commit

Permalink
Merge branch 'main' into rk/dock-wide-screen
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Apr 21, 2022
2 parents 6d0483b + 4d78a77 commit f26a72f
Show file tree
Hide file tree
Showing 149 changed files with 2,909 additions and 21,857 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
#CC# /x-pack/plugins/observability/ @elastic/apm-ui

# Uptime
/x-pack/plugins/uptime @elastic/uptime
/x-pack/plugins/synthetics @elastic/uptime
/x-pack/plugins/ux @elastic/uptime
/x-pack/test/functional_with_es_ssl/apps/uptime @elastic/uptime
/x-pack/test/functional/apps/uptime @elastic/uptime
Expand Down
13 changes: 6 additions & 7 deletions docs/api/cases/cases-api-add-comment.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,20 @@

Adds a comment to a case.

=== Request
=== {api-request-title}

`POST <kibana host>:<port>/api/cases/<case_id>/comments`

`POST <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments`

=== Prerequisite
=== {api-prereq-title}

You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the case you're updating.


=== Path parameters
=== {api-path-parms-title}

`<case_id>`::
(Required,string) The identifier for the case. To retrieve case IDs, use
Expand All @@ -30,7 +29,7 @@ You must have `all` privileges for the *Cases* feature in the *Management*,
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Request body
=== {api-request-body-title}

`alertId`::
(Required*, string) The alert identifier. It is required only when `type` is
Expand Down Expand Up @@ -65,12 +64,12 @@ only when `type` is `alert`. preview:[]
`type`::
(Required, string) The comment type, which must be `user` or `alert`.

=== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

=== Example
=== {api-examples-title}

Add a comment to case ID `293f1bc0-74f6-11ea-b83a-553aecdb28b6`:

Expand Down
16 changes: 8 additions & 8 deletions docs/api/cases/cases-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@

Creates a case.

=== Request
=== {api-request-title}

`POST <kibana host>:<port>/api/cases`

`POST <kibana host>:<port>/s/<space_id>/api/cases`

=== Prerequisite
=== {api-prereq-title}

You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the case you're creating.

=== Path parameters
=== {api-path-parms-title}

`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Request body
=== {api-request-body-title}

`connector`::
(Required, object) An object that contains the connector configuration.
Expand Down Expand Up @@ -107,8 +107,8 @@ For {swimlane} connectors, specify:
`id`::
(Required, string) The identifier for the connector. To create a case without a
connector, use `none`.
//To retrieve connector IDs, use <<cases-api-find-connectors>>).
connector, use `none`. To retrieve connector IDs, use
<<cases-api-find-connectors>>.
`name`::
(Required, string) The name of the connector. To create a case without a
Expand Down Expand Up @@ -147,12 +147,12 @@ categorize cases. It can be an empty array.
`title`::
(Required, string) A title for the case.

=== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

=== Example
=== {api-examples-title}

[source,sh]
--------------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions docs/api/cases/cases-api-delete-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@

Deletes one or more cases.

=== Request
=== {api-request-title}

`DELETE <kibana host>:<port>/api/cases?ids=["<case ID1>","<case ID2>"]`

`DELETE <kibana host>:<port>/s/<space_id>/api/cases?ids=["<case ID1>","<case ID2>"]`

=== Prerequisite
=== {api-prereq-title}

You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're deleting.

=== Path parameters
=== {api-path-parms-title}

`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Query parameters
=== {api-query-parms-title}

`ids`::
(Required, string) The cases that you want to remove. To retrieve case IDs, use
<<cases-api-find-cases>>.
+
NOTE: All non-ASCII characters must be URL encoded.

==== Response code
=== {api-response-codes-title}

`204`::
Indicates a successful call.

=== Example
=== {api-examples-title}

Delete cases with these IDs:

Expand Down
10 changes: 5 additions & 5 deletions docs/api/cases/cases-api-delete-comments.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Deletes one or all comments from a case.

=== Request
=== {api-request-title}

`DELETE <kibana host>:<port>/api/cases/<case_id>/comments`

Expand All @@ -16,14 +16,14 @@ Deletes one or all comments from a case.

`DELETE <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments/<comment_id>`

=== Prerequisite
=== {api-prereq-title}

You must have `all` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're updating.

=== Path parameters
=== {api-path-parms-title}

`<case_id>`::
(Required, string) The identifier for the case. To retrieve case IDs, use
Expand All @@ -38,12 +38,12 @@ comments are deleted.
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Response code
=== {api-response-codes-title}

`204`::
Indicates a successful call.

=== Example
=== {api-examples-title}

Delete all comments from case ID `9c235210-6834-11ea-a78c-6ffb38a34414`:

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

Retrieves a paginated subset of cases.

=== Request
=== {api-request-title}

`GET <kibana host>:<port>/api/cases/_find`

`GET <kibana host>:<port>/s/<space_id>/api/cases/_find`

=== Prerequisite
=== {api-prereq-title}

You must have `read` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're seeking.

=== Path parameters
=== {api-path-parms-title}

`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Query parameters
=== {api-query-parms-title}

`defaultSearchOperator`::
(Optional, string) The default operator to use for the `simple_query_string`.
Expand Down Expand Up @@ -84,12 +84,12 @@ Defaults to `desc`.
`to`::
(Optional, string) Returns only cases that were created before a specific date. The date must be specified as a <<kuery-query,KQL>> data range or date match expression. preview:[]

=== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

=== Example
=== {api-examples-title}

Retrieve the first five cases with the `phishing` tag, in ascending order by
last update time:
Expand Down
10 changes: 5 additions & 5 deletions docs/api/cases/cases-api-find-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,30 @@ 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>>.

=== Request
=== {api-request-title}

`GET <kibana host>:<port>/api/cases/configure/connectors/_find`

`GET <kibana host>:<port>/s/<space_id>/api/cases/configure/connectors/_find`

=== Prerequisite
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

=== Path parameters
=== {api-path-parms-title}

`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

=== Example
=== {api-examples-title}

[source,sh]
--------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cases/cases-api-get-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ default space is used.
`200`::
Indicates a successful call.

=== {api-example-title}
=== {api-examples-title}

Return all alerts attached to case `293f1bc0-74f6-11ea-b83a-553aecdb28b6`:

Expand Down
10 changes: 5 additions & 5 deletions docs/api/cases/cases-api-get-case-activity.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ Returns all user activity for the specified case.

deprecated::[8.1.0]

=== Request
=== {api-request-title}

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

`GET <kibana host>:<port>/s/<space_id>/api/cases/<case ID>/user_actions`

=== Prerequisite
=== {api-prereq-title}

You must have `read` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're seeking.

=== Path parameters
=== {api-path-parms-title}

`<case_id>`::
(Required, string) An identifier for the case to retrieve. Use
Expand All @@ -31,12 +31,12 @@ You must have `read` privileges for the *Cases* feature in the *Management*,
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

==== Example
=== {api-examples-title}

Gets all activity for case ID `a18b38a0-71b0-11ea-a0b2-c51ea50a58e2`:

Expand Down
13 changes: 6 additions & 7 deletions docs/api/cases/cases-api-get-case.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@

Returns a specified case.

=== Request
=== {api-request-title}

`GET <kibana host>:<port>/api/cases/<case ID>`

`GET <kibana host>:<port>/s/<space_id>/api/cases/<case ID>`

=== Prerequisite
=== {api-prereq-title}

You must have `read` privileges for the *Cases* feature in the *Management*,
*{observability}*, or *Security* section of the
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the
`owner` of the cases you're seeking.

=== Path parameters
=== {api-path-parms-title}

`<case_id>`::
(Required, string) An identifier for the case to retrieve. Use
Expand All @@ -29,19 +29,18 @@ You must have `read` privileges for the *Cases* feature in the *Management*,
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Query parameters
=== {api-query-parms-title}

`includeComments`::
(Optional, boolean) Determines whether case comments are returned. Defaults to
`true`. deprecated:[8.1.0, "The `includeComments` query parameter is deprecated and will be removed in a future release."]


==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

==== Example
=== {api-examples-title}

Returns case ID `a18b38a0-71b0-11ea-a0b2-c51ea50a58e2` without comments:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/cases/cases-api-get-cases-by-alert.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ cases that the user has access to read.
`200`::
Indicates a successful call.

=== {api-example-title}
=== {api-examples-title}

Return cases associated with the alert ID
`09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540`:
Expand Down
Loading

0 comments on commit f26a72f

Please sign in to comment.