Update API docs

elastic · Dec 22, 2019 · c36f576 · c36f576
1 parent f520688
commit c36f576
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 0 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.assystemapi.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.assystemapi.md
@@ -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; [asSystemApi](./kibana-plugin-public.httpfetchoptions.assystemapi.md)
+
+## HttpFetchOptions.asSystemApi property
+
+Whether or not the request should include the "system API" header to differentiate from application-level requests. Can be read on the server-side using KibanaRequest\#isSystemApi. Defaults to `false`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+asSystemApi?: boolean;
+```
diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.md
@@ -17,6 +17,7 @@ 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>. |
+|  [asSystemApi](./kibana-plugin-public.httpfetchoptions.assystemapi.md) | <code>boolean</code> | Whether or not the request should include the "system API" header to differentiate from application-level requests. Can be read on the server-side using KibanaRequest\#isSystemApi. 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)<!-- -->. |

diff --git a/docs/development/core/server/kibana-plugin-server.kibanarequest.issystemapi.md b/docs/development/core/server/kibana-plugin-server.kibanarequest.issystemapi.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequest](./kibana-plugin-server.kibanarequest.md) &gt; [isSystemApi](./kibana-plugin-server.kibanarequest.issystemapi.md)
+
+## KibanaRequest.isSystemApi property
+
+Whether or not the request is a "system API" call rather than an application-level call. Can be set on the client using the `asSystemApi` option.
+
+<b>Signature:</b>
+
+```typescript
+readonly isSystemApi: boolean;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.kibanarequest.md b/docs/development/core/server/kibana-plugin-server.kibanarequest.md
@@ -24,6 +24,7 @@ export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unk
 |  --- | --- | --- | --- |
 |  [body](./kibana-plugin-server.kibanarequest.body.md) |  | <code>Body</code> |  |
 |  [headers](./kibana-plugin-server.kibanarequest.headers.md) |  | <code>Headers</code> | Readonly copy of incoming request headers. |
+|  [isSystemApi](./kibana-plugin-server.kibanarequest.issystemapi.md) |  | <code>boolean</code> | Whether or not the request is a "system API" call rather than an application-level call. Can be set on the client using the <code>asSystemApi</code> option. |
 |  [params](./kibana-plugin-server.kibanarequest.params.md) |  | <code>Params</code> |  |
 |  [query](./kibana-plugin-server.kibanarequest.query.md) |  | <code>Query</code> |  |
 |  [route](./kibana-plugin-server.kibanarequest.route.md) |  | <code>RecursiveReadonly&lt;KibanaRequestRoute&lt;Method&gt;&gt;</code> | matched route details |

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -490,6 +490,7 @@ export interface HttpErrorResponse extends IHttpResponse {
 // @public
 export interface HttpFetchOptions extends HttpRequestInit {
     asResponse?: boolean;
+    asSystemApi?: boolean;
     headers?: HttpHeadersInit;
     prependBasePath?: boolean;
     query?: HttpFetchQuery;

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -847,6 +847,7 @@ export class KibanaRequest<Params = unknown, Query = unknown, Body = unknown, Me
     // @internal
     static from<P, Q, B>(req: Request, routeSchemas?: RouteValidator<P, Q, B> | RouteValidatorFullConfig<P, Q, B>, withoutSecretHeaders?: boolean): KibanaRequest<P, Q, B, any>;
     readonly headers: Headers;
+    readonly isSystemApi: boolean;
     // (undocumented)
     readonly params: Params;
     // (undocumented)