-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into reporting/add-new-data-render-error-attribute
- Loading branch information
Showing
784 changed files
with
19,526 additions
and
10,088 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[[short-urls-api]] | ||
== Short URLs APIs | ||
|
||
Manage {kib} short URLs. | ||
|
||
include::short-urls/create-short-url.asciidoc[] | ||
include::short-urls/get-short-url.asciidoc[] | ||
include::short-urls/delete-short-url.asciidoc[] | ||
include::short-urls/resolve-short-url.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
[[short-urls-api-create]] | ||
=== Create short URL API | ||
++++ | ||
<titleabbrev>Create short URL</titleabbrev> | ||
++++ | ||
|
||
experimental[] Create a {kib} short URL. {kib} URLs may be long and cumbersome, short URLs are much | ||
easier to remember and share. | ||
|
||
Short URLs are created by specifying the locator ID and locator parameters. When a short URL is | ||
resolved, the locator ID and locator parameters are used to redirect user to the right {kib} page. | ||
|
||
|
||
[[short-urls-api-create-request]] | ||
==== Request | ||
|
||
`POST <kibana host>:<port>/api/short_url` | ||
|
||
|
||
[[short-urls-api-create-request-body]] | ||
==== Request body | ||
|
||
`locatorId`:: | ||
(Required, string) ID of the locator. | ||
|
||
`params`:: | ||
(Required, object) Object which contains all necessary parameters for the given locator to resolve | ||
to a {kib} location. | ||
+ | ||
WARNING: When you create a short URL, locator params are not validated, which allows you to pass | ||
arbitrary and ill-formed data into the API that can break {kib}. Make sure | ||
any data that you send to the API is properly formed. | ||
|
||
`slug`:: | ||
(Optional, string) A custom short URL slug. Slug is the part of the short URL that identifies it. | ||
You can provide a custom slug which consists of latin alphabet letters, numbers and `-._` | ||
characters. The slug must be at least 3 characters long, but no longer than 255 characters. | ||
|
||
`humanReadableSlug`:: | ||
(Optional, boolean) When the `slug` parameter is omitted, the API will generate a random | ||
human-readable slug, if `humanReadableSlug` is set to `true`. | ||
|
||
|
||
[[short-urls-api-create-response-codes]] | ||
==== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
|
||
[[short-urls-api-create-example]] | ||
==== Example | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
$ curl -X POST api/short_url -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d ' | ||
{ | ||
"locatorId": "LOCATOR_ID", | ||
"params": {}, | ||
"humanReadableSlug": true | ||
}' | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
The API returns the following: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
{ | ||
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", <1> | ||
"slug": "adjective-adjective-noun", <2> | ||
"locator": { | ||
"id": "LOCATOR_ID", | ||
"version": "x.x.x", <3> | ||
"state": {} <4> | ||
}, | ||
"accessCount": 0, | ||
"accessDate": 1632680100000, | ||
"createDate": 1632680100000 | ||
} | ||
-------------------------------------------------- | ||
|
||
<1> A random ID is automatically generated. | ||
<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. | ||
<3> The version of {kib} when short URL was created is stored. | ||
<4> Locator params provided as `params` property are stored. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
[[short-urls-api-delete]] | ||
=== Delete short URL API | ||
++++ | ||
<titleabbrev>Delete short URL</titleabbrev> | ||
++++ | ||
|
||
experimental[] Delete a {kib} short URL. | ||
|
||
|
||
[[short-urls-api-delete-request]] | ||
==== Request | ||
|
||
`DELETE <kibana host>:<port>/api/short_url/<id>` | ||
|
||
|
||
[[short-urls-api-delete-path-params]] | ||
==== Path parameters | ||
|
||
`id`:: | ||
(Required, string) The short URL ID that you want to remove. | ||
|
||
|
||
[[short-urls-api-delete-response-codes]] | ||
==== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
|
||
[[short-urls-api-delete-example]] | ||
==== Example | ||
|
||
Delete a short URL `12345` ID: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
$ curl -X DELETE api/short_url/12345 | ||
-------------------------------------------------- | ||
// KIBANA |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
[[short-urls-api-get]] | ||
=== Get short URL API | ||
++++ | ||
<titleabbrev>Get short URL</titleabbrev> | ||
++++ | ||
|
||
experimental[] Retrieve a single {kib} short URL. | ||
|
||
[[short-urls-api-get-request]] | ||
==== Request | ||
|
||
`GET <kibana host>:<port>/api/short_url/<id>` | ||
|
||
|
||
[[short-urls-api-get-params]] | ||
==== Path parameters | ||
|
||
`id`:: | ||
(Required, string) The ID of the short URL. | ||
|
||
|
||
[[short-urls-api-get-codes]] | ||
==== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
|
||
[[short-urls-api-get-example]] | ||
==== Example | ||
|
||
Retrieve the short URL with the `12345` ID: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
$ curl -X GET api/short_url/12345 | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
The API returns the following: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
{ | ||
"id": "12345", | ||
"slug": "adjective-adjective-noun", | ||
"locator": { | ||
"id": "LOCATOR_ID", | ||
"version": "x.x.x", | ||
"state": {} | ||
}, | ||
"accessCount": 0, | ||
"accessDate": 1632680100000, | ||
"createDate": 1632680100000 | ||
} | ||
-------------------------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
[[short-urls-api-resolve]] | ||
=== Resolve short URL API | ||
++++ | ||
<titleabbrev>Resolve short URL</titleabbrev> | ||
++++ | ||
|
||
experimental[] Resolve a single {kib} short URL by its slug. | ||
|
||
[[short-urls-api-resolve-request]] | ||
==== Request | ||
|
||
`GET <kibana host>:<port>/api/short_url/_slug/<slug>` | ||
|
||
|
||
[[short-urls-api-resolve-params]] | ||
==== Path parameters | ||
|
||
`slug`:: | ||
(Required, string) The slug of the short URL. | ||
|
||
|
||
[[short-urls-api-resolve-codes]] | ||
==== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
|
||
[[short-urls-api-resolve-example]] | ||
==== Example | ||
|
||
Retrieve the short URL with the `hello-world` ID: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
$ curl -X GET api/short_url/_slug/hello-world | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
The API returns the following: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
{ | ||
"id": "12345", | ||
"slug": "hello-world", | ||
"locator": { | ||
"id": "LOCATOR_ID", | ||
"version": "x.x.x", | ||
"state": {} | ||
}, | ||
"accessCount": 0, | ||
"accessDate": 1632680100000, | ||
"createDate": 1632680100000 | ||
} | ||
-------------------------------------------------- |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.