-
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' of github.com:elastic/kibana into timeline-quer…
…y-fields
- Loading branch information
Showing
152 changed files
with
4,084 additions
and
1,883 deletions.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md
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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) | ||
|
||
## HttpSetup.externalUrl property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
externalUrl: IExternalUrl; | ||
``` |
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
20 changes: 20 additions & 0 deletions
20
docs/development/core/public/kibana-plugin-core-public.iexternalurl.md
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,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) | ||
|
||
## IExternalUrl interface | ||
|
||
APIs for working with external URLs. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IExternalUrl | ||
``` | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [validateUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.validateurl.md) | Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml.<!-- -->If the URL is valid, then a URL will be returned. Otherwise, this will return null. | | ||
|
26 changes: 26 additions & 0 deletions
26
docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md
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,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) > [validateUrl](./kibana-plugin-core-public.iexternalurl.validateurl.md) | ||
|
||
## IExternalUrl.validateUrl() method | ||
|
||
Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml. | ||
|
||
If the URL is valid, then a URL will be returned. Otherwise, this will return null. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
validateUrl(relativeOrAbsoluteUrl: string): URL | null; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| relativeOrAbsoluteUrl | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`URL | null` | ||
|
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md
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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | ||
|
||
## IExternalUrlPolicy.allow property | ||
|
||
Indicates if this policy allows or denies access to the described destination. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
allow: boolean; | ||
``` |
24 changes: 24 additions & 0 deletions
24
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md
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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | ||
|
||
## IExternalUrlPolicy.host property | ||
|
||
Optional host describing the external destination. May be combined with `protocol`<!-- -->. Required if `protocol` is not defined. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
host?: string; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
// allows access to all of google.com, using any protocol. | ||
allow: true, | ||
host: 'google.com' | ||
|
||
``` | ||
|
22 changes: 22 additions & 0 deletions
22
docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md
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,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) | ||
|
||
## IExternalUrlPolicy interface | ||
|
||
A policy describing whether access to an external destination is allowed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IExternalUrlPolicy | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | <code>boolean</code> | Indicates if this policy allows or denies access to the described destination. | | ||
| [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | <code>string</code> | Optional host describing the external destination. May be combined with <code>protocol</code>. Required if <code>protocol</code> is not defined. | | ||
| [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | <code>string</code> | Optional protocol describing the external destination. May be combined with <code>host</code>. Required if <code>host</code> is not defined. | | ||
|
24 changes: 24 additions & 0 deletions
24
...evelopment/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md
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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | ||
|
||
## IExternalUrlPolicy.protocol property | ||
|
||
Optional protocol describing the external destination. May be combined with `host`<!-- -->. Required if `host` is not defined. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
protocol?: string; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
// allows access to all destinations over the `https` protocol. | ||
allow: true, | ||
protocol: 'https' | ||
|
||
``` | ||
|
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
20 changes: 20 additions & 0 deletions
20
docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md
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,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) | ||
|
||
## IExternalUrlConfig interface | ||
|
||
External Url configuration for use in Kibana. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IExternalUrlConfig | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) | <code>IExternalUrlPolicy[]</code> | A set of policies describing which external urls are allowed. | | ||
|
13 changes: 13 additions & 0 deletions
13
.../development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md
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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) > [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) | ||
|
||
## IExternalUrlConfig.policy property | ||
|
||
A set of policies describing which external urls are allowed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly policy: IExternalUrlPolicy[]; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md
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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | ||
|
||
## IExternalUrlPolicy.allow property | ||
|
||
Indicates of this policy allows or denies access to the described destination. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
allow: boolean; | ||
``` |
24 changes: 24 additions & 0 deletions
24
docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md
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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [host](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | ||
|
||
## IExternalUrlPolicy.host property | ||
|
||
Optional host describing the external destination. May be combined with `protocol`<!-- -->. Required if `protocol` is not defined. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
host?: string; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
// allows access to all of google.com, using any protocol. | ||
allow: true, | ||
host: 'google.com' | ||
|
||
``` | ||
|
22 changes: 22 additions & 0 deletions
22
docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md
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,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) | ||
|
||
## IExternalUrlPolicy interface | ||
|
||
A policy describing whether access to an external destination is allowed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IExternalUrlPolicy | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | <code>boolean</code> | Indicates of this policy allows or denies access to the described destination. | | ||
| [host](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | <code>string</code> | Optional host describing the external destination. May be combined with <code>protocol</code>. Required if <code>protocol</code> is not defined. | | ||
| [protocol](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | <code>string</code> | Optional protocol describing the external destination. May be combined with <code>host</code>. Required if <code>host</code> is not defined. | | ||
|
24 changes: 24 additions & 0 deletions
24
...evelopment/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md
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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | ||
|
||
## IExternalUrlPolicy.protocol property | ||
|
||
Optional protocol describing the external destination. May be combined with `host`<!-- -->. Required if `host` is not defined. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
protocol?: string; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
// allows access to all destinations over the `https` protocol. | ||
allow: true, | ||
protocol: 'https' | ||
|
||
``` | ||
|
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
Oops, something went wrong.