Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export public http interfaces #42001

Merged
merged 3 commits into from
Jul 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httpbody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpBody](./kibana-plugin-public.httpbody.md)

## HttpBody type


<b>Signature:</b>

```typescript
export declare type HttpBody = BodyInit | null | any;
```
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; [HttpErrorRequest](./kibana-plugin-public.httperrorrequest.md) &gt; [error](./kibana-plugin-public.httperrorrequest.error.md)

## HttpErrorRequest.error property

<b>Signature:</b>

```typescript
error: Error;
```
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; [HttpErrorRequest](./kibana-plugin-public.httperrorrequest.md)

## HttpErrorRequest interface


<b>Signature:</b>

```typescript
export interface HttpErrorRequest
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-public.httperrorrequest.error.md) | <code>Error</code> | |
| [request](./kibana-plugin-public.httperrorrequest.request.md) | <code>Request</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; [HttpErrorRequest](./kibana-plugin-public.httperrorrequest.md) &gt; [request](./kibana-plugin-public.httperrorrequest.request.md)

## HttpErrorRequest.request property

<b>Signature:</b>

```typescript
request?: Request;
```
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; [HttpErrorResponse](./kibana-plugin-public.httperrorresponse.md) &gt; [error](./kibana-plugin-public.httperrorresponse.error.md)

## HttpErrorResponse.error property

<b>Signature:</b>

```typescript
error: Error | HttpFetchError;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpErrorResponse](./kibana-plugin-public.httperrorresponse.md)

## HttpErrorResponse interface


<b>Signature:</b>

```typescript
export interface HttpErrorResponse extends HttpResponse
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [error](./kibana-plugin-public.httperrorresponse.error.md) | <code>Error &#124; HttpFetchError</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; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [headers](./kibana-plugin-public.httpfetchoptions.headers.md)

## HttpFetchOptions.headers property

<b>Signature:</b>

```typescript
headers?: HttpHeadersInit;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- 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)

## HttpFetchOptions interface


<b>Signature:</b>

```typescript
export interface HttpFetchOptions extends HttpRequestInit
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | |
| [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md) | <code>boolean</code> | |
| [query](./kibana-plugin-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</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; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md)

## HttpFetchOptions.prependBasePath property

<b>Signature:</b>

```typescript
prependBasePath?: boolean;
```
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; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [query](./kibana-plugin-public.httpfetchoptions.query.md)

## HttpFetchOptions.query property

<b>Signature:</b>

```typescript
query?: HttpFetchQuery;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)

## HttpFetchQuery interface


<b>Signature:</b>

```typescript
export interface HttpFetchQuery
```
12 changes: 12 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httphandler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## HttpHandler type


<b>Signature:</b>

```typescript
export declare type HttpHandler = (path: string, options?: HttpFetchOptions) => Promise<HttpBody>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)

## HttpHeadersInit interface


<b>Signature:</b>

```typescript
export interface HttpHeadersInit
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [body](./kibana-plugin-public.httprequestinit.body.md)

## HttpRequestInit.body property

<b>Signature:</b>

```typescript
body?: BodyInit | null;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [cache](./kibana-plugin-public.httprequestinit.cache.md)

## HttpRequestInit.cache property

<b>Signature:</b>

```typescript
cache?: RequestCache;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [credentials](./kibana-plugin-public.httprequestinit.credentials.md)

## HttpRequestInit.credentials property

<b>Signature:</b>

```typescript
credentials?: RequestCredentials;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [headers](./kibana-plugin-public.httprequestinit.headers.md)

## HttpRequestInit.headers property

<b>Signature:</b>

```typescript
headers?: HttpHeadersInit;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [integrity](./kibana-plugin-public.httprequestinit.integrity.md)

## HttpRequestInit.integrity property

<b>Signature:</b>

```typescript
integrity?: string;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [keepalive](./kibana-plugin-public.httprequestinit.keepalive.md)

## HttpRequestInit.keepalive property

<b>Signature:</b>

```typescript
keepalive?: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md)

## HttpRequestInit interface


<b>Signature:</b>

```typescript
export interface HttpRequestInit
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [body](./kibana-plugin-public.httprequestinit.body.md) | <code>BodyInit &#124; null</code> | |
| [cache](./kibana-plugin-public.httprequestinit.cache.md) | <code>RequestCache</code> | |
| [credentials](./kibana-plugin-public.httprequestinit.credentials.md) | <code>RequestCredentials</code> | |
| [headers](./kibana-plugin-public.httprequestinit.headers.md) | <code>HttpHeadersInit</code> | |
| [integrity](./kibana-plugin-public.httprequestinit.integrity.md) | <code>string</code> | |
| [keepalive](./kibana-plugin-public.httprequestinit.keepalive.md) | <code>boolean</code> | |
| [method](./kibana-plugin-public.httprequestinit.method.md) | <code>string</code> | |
| [mode](./kibana-plugin-public.httprequestinit.mode.md) | <code>RequestMode</code> | |
| [redirect](./kibana-plugin-public.httprequestinit.redirect.md) | <code>RequestRedirect</code> | |
| [referrer](./kibana-plugin-public.httprequestinit.referrer.md) | <code>string</code> | |
| [referrerPolicy](./kibana-plugin-public.httprequestinit.referrerpolicy.md) | <code>ReferrerPolicy</code> | |
| [signal](./kibana-plugin-public.httprequestinit.signal.md) | <code>AbortSignal &#124; null</code> | |
| [window](./kibana-plugin-public.httprequestinit.window.md) | <code>any</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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [method](./kibana-plugin-public.httprequestinit.method.md)

## HttpRequestInit.method property

<b>Signature:</b>

```typescript
method?: string;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [mode](./kibana-plugin-public.httprequestinit.mode.md)

## HttpRequestInit.mode property

<b>Signature:</b>

```typescript
mode?: RequestMode;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [redirect](./kibana-plugin-public.httprequestinit.redirect.md)

## HttpRequestInit.redirect property

<b>Signature:</b>

```typescript
redirect?: RequestRedirect;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [referrer](./kibana-plugin-public.httprequestinit.referrer.md)

## HttpRequestInit.referrer property

<b>Signature:</b>

```typescript
referrer?: string;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [referrerPolicy](./kibana-plugin-public.httprequestinit.referrerpolicy.md)

## HttpRequestInit.referrerPolicy property

<b>Signature:</b>

```typescript
referrerPolicy?: ReferrerPolicy;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [signal](./kibana-plugin-public.httprequestinit.signal.md)

## HttpRequestInit.signal property

<b>Signature:</b>

```typescript
signal?: AbortSignal | null;
```
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; [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) &gt; [window](./kibana-plugin-public.httprequestinit.window.md)

## HttpRequestInit.window property

<b>Signature:</b>

```typescript
window?: any;
```
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; [HttpResponse](./kibana-plugin-public.httpresponse.md) &gt; [body](./kibana-plugin-public.httpresponse.body.md)

## HttpResponse.body property

<b>Signature:</b>

```typescript
body?: HttpBody;
```
Loading