diff --git a/docs/development/core/public/kibana-plugin-public.httpfetchoptions.assystemapi.md b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.assystemapi.md new file mode 100644 index 000000000000000..3dd6dddbfba34e0 --- /dev/null +++ b/docs/development/core/public/kibana-plugin-public.httpfetchoptions.assystemapi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) > [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`. + +Signature: + +```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 index 6a0c4a8a7f1379a..f8a589e2a375cf3 100644 --- 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) | boolean | 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. | +| [asSystemApi](./kibana-plugin-public.httpfetchoptions.assystemapi.md) | boolean | 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. | | [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | HttpHeadersInit | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md). | | [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md) | boolean | Whether or not the request should automatically prepend the basePath. Defaults to true. | | [query](./kibana-plugin-public.httpfetchoptions.query.md) | HttpFetchQuery | 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 new file mode 100644 index 000000000000000..4bf222a37be0487 --- /dev/null +++ b/docs/development/core/server/kibana-plugin-server.kibanarequest.issystemapi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [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. + +Signature: + +```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 index bc805fdc0b86f17..fa163f628546e75 100644 --- 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 KibanaRequestBody | | | [headers](./kibana-plugin-server.kibanarequest.headers.md) | | Headers | Readonly copy of incoming request headers. | +| [isSystemApi](./kibana-plugin-server.kibanarequest.issystemapi.md) | | boolean | 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. | | [params](./kibana-plugin-server.kibanarequest.params.md) | | Params | | | [query](./kibana-plugin-server.kibanarequest.query.md) | | Query | | | [route](./kibana-plugin-server.kibanarequest.route.md) | | RecursiveReadonly<KibanaRequestRoute<Method>> | matched route details | diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md index dfbb6b4a6fbf549..af6b284c5941de7 100644 --- 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 index ef5368751c8f5aa..a083ca94e333838 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -847,6 +847,7 @@ export class KibanaRequest(req: Request, routeSchemas?: RouteValidator | RouteValidatorFullConfig, withoutSecretHeaders?: boolean): KibanaRequest; readonly headers: Headers; + readonly isSystemApi: boolean; // (undocumented) readonly params: Params; // (undocumented)