Skip to content

Commit

Permalink
Merge branch 'master' into fix-54125-3
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine committed Jan 27, 2020
2 parents c2a8910 + e00f262 commit 299e7d4
Show file tree
Hide file tree
Showing 440 changed files with 7,315 additions and 4,787 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ The `config/kibana.yml` file stores user configuration directives. Since this fi

#### Setting Up SSL

Kibana includes a self-signed certificate that can be used for development purposes: `yarn start --ssl`.
Kibana includes self-signed certificates that can be used for development purposes in the browser and for communicating with Elasticsearch: `yarn start --ssl` & `yarn es snapshot --ssl`.

### Linting

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## HttpFetchOptions.asResponse property

When `true` the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) with detailed request and response information. When `false`<!-- -->, the return type will just be the parsed response body. Defaults to `false`<!-- -->.
When `true` the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-public.httpresponse.md) with detailed request and response information. When `false`<!-- -->, the return type will just be the parsed response body. Defaults to `false`<!-- -->.

<b>Signature:</b>

Expand Down
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [asSystemRequest](./kibana-plugin-public.httpfetchoptions.assystemrequest.md)

## HttpFetchOptions.asSystemRequest property

Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to `false`<!-- -->.

<b>Signature:</b>

```typescript
asSystemRequest?: boolean;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ export interface HttpFetchOptions extends HttpRequestInit
| Property | Type | Description |
| --- | --- | --- |
| [asResponse](./kibana-plugin-public.httpfetchoptions.asresponse.md) | <code>boolean</code> | When <code>true</code> the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) with detailed request and response information. When <code>false</code>, the return type will just be the parsed response body. Defaults to <code>false</code>. |
| [asResponse](./kibana-plugin-public.httpfetchoptions.asresponse.md) | <code>boolean</code> | When <code>true</code> the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-public.httpresponse.md) with detailed request and response information. When <code>false</code>, the return type will just be the parsed response body. Defaults to <code>false</code>. |
| [asSystemRequest](./kibana-plugin-public.httpfetchoptions.assystemrequest.md) | <code>boolean</code> | Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to <code>false</code>. |
| [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)<!-- -->. |
| [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md) | <code>boolean</code> | Whether or not the request should automatically prepend the basePath. Defaults to <code>true</code>. |
| [query](./kibana-plugin-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> | The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)<!-- -->. |
Expand Down
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchOptionsWithPath](./kibana-plugin-public.httpfetchoptionswithpath.md)

## HttpFetchOptionsWithPath interface

Similar to [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) but with the URL path included.

<b>Signature:</b>

```typescript
export interface HttpFetchOptionsWithPath extends HttpFetchOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [path](./kibana-plugin-public.httpfetchoptionswithpath.path.md) | <code>string</code> | |
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchOptionsWithPath](./kibana-plugin-public.httpfetchoptionswithpath.md) &gt; [path](./kibana-plugin-public.httpfetchoptionswithpath.path.md)

## HttpFetchOptionsWithPath.path property

<b>Signature:</b>

```typescript
path: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## HttpHandler interface

A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) for the response.
A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-public.httpresponse.md) for the response.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## HttpHeadersInit interface

Headers to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause [HttpHandler](./kibana-plugin-public.httphandler.md) to throw an error.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface HttpInterceptor

| Method | Description |
| --- | --- |
| [request(request, controller)](./kibana-plugin-public.httpinterceptor.request.md) | Define an interceptor to be executed before a request is sent. |
| [request(fetchOptions, controller)](./kibana-plugin-public.httpinterceptor.request.md) | Define an interceptor to be executed before a request is sent. |
| [requestError(httpErrorRequest, controller)](./kibana-plugin-public.httpinterceptor.requesterror.md) | Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. |
| [response(httpResponse, controller)](./kibana-plugin-public.httpinterceptor.response.md) | Define an interceptor to be executed after a response is received. |
| [responseError(httpErrorResponse, controller)](./kibana-plugin-public.httpinterceptor.responseerror.md) | Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Define an interceptor to be executed before a request is sent.
<b>Signature:</b>

```typescript
request?(request: Request, controller: IHttpInterceptController): Promise<Request> | Request | void;
request?(fetchOptions: Readonly<HttpFetchOptionsWithPath>, controller: IHttpInterceptController): MaybePromise<Partial<HttpFetchOptionsWithPath>> | void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| request | <code>Request</code> | |
| fetchOptions | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | |
| controller | <code>IHttpInterceptController</code> | |
<b>Returns:</b>
`Promise<Request> | Request | void`
`MaybePromise<Partial<HttpFetchOptionsWithPath>> | void`
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Define an interceptor to be executed if a request interceptor throws an error or
<b>Signature:</b>

```typescript
requestError?(httpErrorRequest: HttpErrorRequest, controller: IHttpInterceptController): Promise<Request> | Request | void;
requestError?(httpErrorRequest: HttpInterceptorRequestError, controller: IHttpInterceptController): MaybePromise<Partial<HttpFetchOptionsWithPath>> | void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| httpErrorRequest | <code>HttpErrorRequest</code> | |
| httpErrorRequest | <code>HttpInterceptorRequestError</code> | |
| controller | <code>IHttpInterceptController</code> | |
<b>Returns:</b>
`Promise<Request> | Request | void`
`MaybePromise<Partial<HttpFetchOptionsWithPath>> | void`
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Define an interceptor to be executed after a response is received.
<b>Signature:</b>

```typescript
response?(httpResponse: IHttpResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
response?(httpResponse: HttpResponse, controller: IHttpInterceptController): MaybePromise<IHttpResponseInterceptorOverrides> | void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| httpResponse | <code>IHttpResponse</code> | |
| httpResponse | <code>HttpResponse</code> | |
| controller | <code>IHttpInterceptController</code> | |
<b>Returns:</b>
`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
`MaybePromise<IHttpResponseInterceptorOverrides> | void`
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Define an interceptor to be executed if a response interceptor throws an error o
<b>Signature:</b>

```typescript
responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
responseError?(httpErrorResponse: HttpInterceptorResponseError, controller: IHttpInterceptController): MaybePromise<IHttpResponseInterceptorOverrides> | void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| httpErrorResponse | <code>HttpErrorResponse</code> | |
| httpErrorResponse | <code>HttpInterceptorResponseError</code> | |
| controller | <code>IHttpInterceptController</code> | |
<b>Returns:</b>
`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
`MaybePromise<IHttpResponseInterceptorOverrides> | void`
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorRequestError](./kibana-plugin-public.httpinterceptorrequesterror.md) &gt; [error](./kibana-plugin-public.httpinterceptorrequesterror.error.md)

## HttpInterceptorRequestError.error property

<b>Signature:</b>

```typescript
error: Error;
```
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorRequestError](./kibana-plugin-public.httpinterceptorrequesterror.md) &gt; [fetchOptions](./kibana-plugin-public.httpinterceptorrequesterror.fetchoptions.md)

## HttpInterceptorRequestError.fetchOptions property

<b>Signature:</b>

```typescript
fetchOptions: Readonly<HttpFetchOptionsWithPath>;
```
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorRequestError](./kibana-plugin-public.httpinterceptorrequesterror.md)

## HttpInterceptorRequestError interface


<b>Signature:</b>

```typescript
export interface HttpInterceptorRequestError
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-public.httpinterceptorrequesterror.error.md) | <code>Error</code> | |
| [fetchOptions](./kibana-plugin-public.httpinterceptorrequesterror.fetchoptions.md) | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | |

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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorResponseError](./kibana-plugin-public.httpinterceptorresponseerror.md) &gt; [error](./kibana-plugin-public.httpinterceptorresponseerror.error.md)

## HttpInterceptorResponseError.error property

<b>Signature:</b>

```typescript
error: Error | IHttpFetchError;
```
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorResponseError](./kibana-plugin-public.httpinterceptorresponseerror.md)

## HttpInterceptorResponseError interface


<b>Signature:</b>

```typescript
export interface HttpInterceptorResponseError extends HttpResponse
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-public.httpinterceptorresponseerror.error.md) | <code>Error &#124; IHttpFetchError</code> | |
| [request](./kibana-plugin-public.httpinterceptorresponseerror.request.md) | <code>Readonly&lt;Request&gt;</code> | |
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpInterceptorResponseError](./kibana-plugin-public.httpinterceptorresponseerror.md) &gt; [request](./kibana-plugin-public.httpinterceptorresponseerror.request.md)

## HttpInterceptorResponseError.request property

<b>Signature:</b>

```typescript
request: Readonly<Request>;
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) &gt; [body](./kibana-plugin-public.ihttpresponse.body.md)
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpResponse](./kibana-plugin-public.httpresponse.md) &gt; [body](./kibana-plugin-public.httpresponse.body.md)

## IHttpResponse.body property
## HttpResponse.body property

Parsed body received, may be undefined if there was an error.

Expand Down
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpResponse](./kibana-plugin-public.httpresponse.md) &gt; [fetchOptions](./kibana-plugin-public.httpresponse.fetchoptions.md)

## HttpResponse.fetchOptions property

The original [HttpFetchOptionsWithPath](./kibana-plugin-public.httpfetchoptionswithpath.md) used to send this request.

<b>Signature:</b>

```typescript
readonly fetchOptions: Readonly<HttpFetchOptionsWithPath>;
```
22 changes: 22 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httpresponse.md
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) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpResponse](./kibana-plugin-public.httpresponse.md)

## HttpResponse interface


<b>Signature:</b>

```typescript
export interface HttpResponse<TResponseBody = any>
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [body](./kibana-plugin-public.httpresponse.body.md) | <code>TResponseBody</code> | Parsed body received, may be undefined if there was an error. |
| [fetchOptions](./kibana-plugin-public.httpresponse.fetchoptions.md) | <code>Readonly&lt;HttpFetchOptionsWithPath&gt;</code> | The original [HttpFetchOptionsWithPath](./kibana-plugin-public.httpfetchoptionswithpath.md) used to send this request. |
| [request](./kibana-plugin-public.httpresponse.request.md) | <code>Readonly&lt;Request&gt;</code> | Raw request sent to Kibana server. |
| [response](./kibana-plugin-public.httpresponse.response.md) | <code>Readonly&lt;Response&gt;</code> | Raw response received, may be undefined if there was an error. |

Loading

0 comments on commit 299e7d4

Please sign in to comment.