Skip to content

Commit 9b7b940

Browse files
committed
Merge branch 'master' of github.com:elastic/kibana into disable_collection_link_fix
2 parents 5f467c4 + a91e53f commit 9b7b940

File tree

75 files changed

+1522
-606
lines changed

Some content is hidden

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

75 files changed

+1522
-606
lines changed

docs/development/core/public/kibana-plugin-public.httpbody.md

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

docs/development/core/public/kibana-plugin-public.httperrorresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export interface HttpErrorResponse extends HttpResponse
11+
export interface HttpErrorResponse extends IHttpResponse
1212
```
1313
1414
## Properties
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [asResponse](./kibana-plugin-public.httpfetchoptions.asresponse.md)
4+
5+
## HttpFetchOptions.asResponse property
6+
7+
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`<!-- -->.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
asResponse?: boolean;
13+
```

docs/development/core/public/kibana-plugin-public.httpfetchoptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export interface HttpFetchOptions extends HttpRequestInit
1616
1717
| Property | Type | Description |
1818
| --- | --- | --- |
19+
| [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>. |
1920
| [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)<!-- -->. |
2021
| [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>. |
2122
| [query](./kibana-plugin-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> | The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)<!-- -->. |

docs/development/core/public/kibana-plugin-public.httphandler.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpHandler](./kibana-plugin-public.httphandler.md)
44

5-
## HttpHandler type
5+
## HttpHandler interface
66

7-
A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [HttpBody](./kibana-plugin-public.httpbody.md) for the response.
7+
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.
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
export declare type HttpHandler = (path: string, options?: HttpFetchOptions) => Promise<HttpBody>;
12+
export interface HttpHandler
1313
```

docs/development/core/public/kibana-plugin-public.httpinterceptor.response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ Define an interceptor to be executed after a response is received.
99
<b>Signature:</b>
1010

1111
```typescript
12-
response?(httpResponse: HttpResponse, controller: IHttpInterceptController): Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void;
12+
response?(httpResponse: IHttpResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
1313
```
1414
1515
## Parameters
1616
1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| httpResponse | <code>HttpResponse</code> | |
19+
| httpResponse | <code>IHttpResponse</code> | |
2020
| controller | <code>IHttpInterceptController</code> | |
2121
2222
<b>Returns:</b>
2323
24-
`Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void`
24+
`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
2525

docs/development/core/public/kibana-plugin-public.httpinterceptor.responseerror.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Define an interceptor to be executed if a response interceptor throws an error o
99
<b>Signature:</b>
1010

1111
```typescript
12-
responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void;
12+
responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
1313
```
1414
1515
## Parameters
@@ -21,5 +21,5 @@ responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptC
2121
2222
<b>Returns:</b>
2323
24-
`Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void`
24+
`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
2525

docs/development/core/public/kibana-plugin-public.httpresponse.md

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

docs/development/core/public/kibana-plugin-public.httpresponse.request.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## IHttpResponse.body property
6+
7+
Parsed body received, may be undefined if there was an error.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly body?: TResponseBody;
13+
```

0 commit comments

Comments
 (0)