Skip to content

Commit 1bdbe33

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into feat/olm-host_isolation_api_changes-1704
2 parents dddf9b6 + 7ffebf1 commit 1bdbe33

File tree

160 files changed

+6377
-1577
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+6377
-1577
lines changed

‎docs/api/short-urls.asciidoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[[short-urls-api]]
2+
== Short URLs APIs
3+
4+
Manage {kib} short URLs.
5+
6+
include::short-urls/create-short-url.asciidoc[]
7+
include::short-urls/get-short-url.asciidoc[]
8+
include::short-urls/delete-short-url.asciidoc[]
9+
include::short-urls/resolve-short-url.asciidoc[]

‎docs/api/short-urls/create-short-url.asciidoc‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
[[short-urls-api-create]]
2+
=== Create short URL API
3+
++++
4+
<titleabbrev>Create short URL</titleabbrev>
5+
++++
6+
7+
experimental[] Create a {kib} short URL. {kib} URLs may be long and cumbersome, short URLs are much
8+
easier to remember and share.
9+
10+
Short URLs are created by specifying the locator ID and locator parameters. When a short URL is
11+
resolved, the locator ID and locator parameters are used to redirect user to the right {kib} page.
12+
13+
14+
[[short-urls-api-create-request]]
15+
==== Request
16+
17+
`POST <kibana host>:<port>/api/short_url`
18+
19+
20+
[[short-urls-api-create-request-body]]
21+
==== Request body
22+
23+
`locatorId`::
24+
(Required, string) ID of the locator.
25+
26+
`params`::
27+
(Required, object) Object which contains all necessary parameters for the given locator to resolve
28+
to a {kib} location.
29+
+
30+
WARNING: When you create a short URL, locator params are not validated, which allows you to pass
31+
arbitrary and ill-formed data into the API that can break {kib}. Make sure
32+
any data that you send to the API is properly formed.
33+
34+
`slug`::
35+
(Optional, string) A custom short URL slug. Slug is the part of the short URL that identifies it.
36+
You can provide a custom slug which consists of latin alphabet letters, numbers and `-._`
37+
characters. The slug must be at least 3 characters long, but no longer than 255 characters.
38+
39+
`humanReadableSlug`::
40+
(Optional, boolean) When the `slug` parameter is omitted, the API will generate a random
41+
human-readable slug, if `humanReadableSlug` is set to `true`.
42+
43+
44+
[[short-urls-api-create-response-codes]]
45+
==== Response code
46+
47+
`200`::
48+
Indicates a successful call.
49+
50+
51+
[[short-urls-api-create-example]]
52+
==== Example
53+
54+
[source,sh]
55+
--------------------------------------------------
56+
$ curl -X POST api/short_url -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
57+
{
58+
"locatorId": "LOCATOR_ID",
59+
"params": {},
60+
"humanReadableSlug": true
61+
}'
62+
--------------------------------------------------
63+
// KIBANA
64+
65+
The API returns the following:
66+
67+
[source,sh]
68+
--------------------------------------------------
69+
{
70+
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", <1>
71+
"slug": "adjective-adjective-noun", <2>
72+
"locator": {
73+
"id": "LOCATOR_ID",
74+
"version": "x.x.x", <3>
75+
"state": {} <4>
76+
},
77+
"accessCount": 0,
78+
"accessDate": 1632680100000,
79+
"createDate": 1632680100000
80+
}
81+
--------------------------------------------------
82+
83+
<1> A random ID is automatically generated.
84+
<2> A random human-readable slug is automatically generated if the `humanReadableSlug` parameter is set to `true`. If set to `false` a random short string is generated.
85+
<3> The version of {kib} when short URL was created is stored.
86+
<4> Locator params provided as `params` property are stored.

‎docs/api/short-urls/delete-short-url.asciidoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
[[short-urls-api-delete]]
2+
=== Delete short URL API
3+
++++
4+
<titleabbrev>Delete short URL</titleabbrev>
5+
++++
6+
7+
experimental[] Delete a {kib} short URL.
8+
9+
10+
[[short-urls-api-delete-request]]
11+
==== Request
12+
13+
`DELETE <kibana host>:<port>/api/short_url/<id>`
14+
15+
16+
[[short-urls-api-delete-path-params]]
17+
==== Path parameters
18+
19+
`id`::
20+
(Required, string) The short URL ID that you want to remove.
21+
22+
23+
[[short-urls-api-delete-response-codes]]
24+
==== Response code
25+
26+
`200`::
27+
Indicates a successful call.
28+
29+
30+
[[short-urls-api-delete-example]]
31+
==== Example
32+
33+
Delete a short URL `12345` ID:
34+
35+
[source,sh]
36+
--------------------------------------------------
37+
$ curl -X DELETE api/short_url/12345
38+
--------------------------------------------------
39+
// KIBANA

‎docs/api/short-urls/get-short-url.asciidoc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[[short-urls-api-get]]
2+
=== Get short URL API
3+
++++
4+
<titleabbrev>Get short URL</titleabbrev>
5+
++++
6+
7+
experimental[] Retrieve a single {kib} short URL.
8+
9+
[[short-urls-api-get-request]]
10+
==== Request
11+
12+
`GET <kibana host>:<port>/api/short_url/<id>`
13+
14+
15+
[[short-urls-api-get-params]]
16+
==== Path parameters
17+
18+
`id`::
19+
(Required, string) The ID of the short URL.
20+
21+
22+
[[short-urls-api-get-codes]]
23+
==== Response code
24+
25+
`200`::
26+
Indicates a successful call.
27+
28+
29+
[[short-urls-api-get-example]]
30+
==== Example
31+
32+
Retrieve the short URL with the `12345` ID:
33+
34+
[source,sh]
35+
--------------------------------------------------
36+
$ curl -X GET api/short_url/12345
37+
--------------------------------------------------
38+
// KIBANA
39+
40+
The API returns the following:
41+
42+
[source,sh]
43+
--------------------------------------------------
44+
{
45+
"id": "12345",
46+
"slug": "adjective-adjective-noun",
47+
"locator": {
48+
"id": "LOCATOR_ID",
49+
"version": "x.x.x",
50+
"state": {}
51+
},
52+
"accessCount": 0,
53+
"accessDate": 1632680100000,
54+
"createDate": 1632680100000
55+
}
56+
--------------------------------------------------

‎docs/api/short-urls/resolve-short-url.asciidoc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[[short-urls-api-resolve]]
2+
=== Resolve short URL API
3+
++++
4+
<titleabbrev>Resolve short URL</titleabbrev>
5+
++++
6+
7+
experimental[] Resolve a single {kib} short URL by its slug.
8+
9+
[[short-urls-api-resolve-request]]
10+
==== Request
11+
12+
`GET <kibana host>:<port>/api/short_url/_slug/<slug>`
13+
14+
15+
[[short-urls-api-resolve-params]]
16+
==== Path parameters
17+
18+
`slug`::
19+
(Required, string) The slug of the short URL.
20+
21+
22+
[[short-urls-api-resolve-codes]]
23+
==== Response code
24+
25+
`200`::
26+
Indicates a successful call.
27+
28+
29+
[[short-urls-api-resolve-example]]
30+
==== Example
31+
32+
Retrieve the short URL with the `hello-world` ID:
33+
34+
[source,sh]
35+
--------------------------------------------------
36+
$ curl -X GET api/short_url/_slug/hello-world
37+
--------------------------------------------------
38+
// KIBANA
39+
40+
The API returns the following:
41+
42+
[source,sh]
43+
--------------------------------------------------
44+
{
45+
"id": "12345",
46+
"slug": "hello-world",
47+
"locator": {
48+
"id": "LOCATOR_ID",
49+
"version": "x.x.x",
50+
"state": {}
51+
},
52+
"accessCount": 0,
53+
"accessDate": 1632680100000,
54+
"createDate": 1632680100000
55+
}
56+
--------------------------------------------------

‎docs/api/url-shortening.asciidoc‎

Lines changed: 0 additions & 62 deletions
This file was deleted.

‎docs/developer/plugin-list.asciidoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,8 @@ The plugin exposes the static DefaultEditorController class to consume.
362362
363363
364364
|{kib-repo}blob/{branch}/x-pack/plugins/cases/README.md[cases]
365-
|Case management in Kibana
365+
|[![Issues][issues-shield]][issues-url]
366+
[![Pull Requests][pr-shield]][pr-url]
366367
367368
368369
|{kib-repo}blob/{branch}/x-pack/plugins/cloud/README.md[cloud]

‎docs/management/action-types.asciidoc‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,14 @@ a| <<server-log-action-type, ServerLog>>
3535

3636
| Add a message to a Kibana log.
3737

38-
a| <<servicenow-action-type, ServiceNow>>
38+
a| <<servicenow-action-type, ServiceNow ITSM>>
3939

4040
| Create an incident in ServiceNow.
4141

42+
a| <<servicenow-sir-action-type, ServiceNow SecOps>>
43+
44+
| Create a security incident in ServiceNow.
45+
4246
a| <<slack-action-type, Slack>>
4347

4448
| Send a message to a Slack channel or user.

0 commit comments

Comments
 (0)