Update @microsoft/api-extractor + @microsoft/api-documentor (#46193)

2025-04-24 09:48:58 -04:00 · 2019-09-23 09:50:59 -05:00 · 2019-09-23 09:50:59 -05:00 · cbe9161eb5
commit cbe9161eb5
parent a5b5b8816b
57 changed files with 269 additions and 148 deletions
--- a/docs/development/core/public/index.md
+++ b/docs/development/core/public/index.md
@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [kibana-plugin-public](./kibana-plugin-public.md) | The Kibana Core APIs for client-side plugins.<!-- -->A plugin's <code>public/index</code> file must contain a named import, <code>plugin</code>, that implements  which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either  or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
+
--- a/docs/development/core/public/kibana-plugin-public.appbase.md
+++ b/docs/development/core/public/kibana-plugin-public.appbase.md
@ -21,5 +21,5 @@ export interface AppBase
 |  [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> |  |
 |  [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
 |  [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
-|  [tooltip$](./kibana-plugin-public.appbase.tooltip$.md) | <code>Observable&lt;string&gt;</code> | An observable for a tooltip shown when hovering over app link. |
+|  [tooltip$](./kibana-plugin-public.appbase.tooltip_.md) | <code>Observable&lt;string&gt;</code> | An observable for a tooltip shown when hovering over app link. |

--- a/docs/development/core/public/kibana-plugin-public.appbase.tooltip_.md
+++ b/docs/development/core/public/kibana-plugin-public.appbase.tooltip_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [tooltip$](./kibana-plugin-public.appbase.tooltip$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [tooltip$](./kibana-plugin-public.appbase.tooltip_.md)

 ## AppBase.tooltip$ property

--- a/docs/development/core/public/kibana-plugin-public.chromebreadcrumb._data-test-subj_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromebreadcrumb._data-test-subj_.md
@ -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; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; ["data-test-subj"](./kibana-plugin-public.chromebreadcrumb._data-test-subj_.md)

-## ChromeBreadcrumb.data-test-subj property
+## ChromeBreadcrumb."data-test-subj" property

 <b>Signature:</b>

--- a/docs/development/core/public/kibana-plugin-public.chromebreadcrumb.md
+++ b/docs/development/core/public/kibana-plugin-public.chromebreadcrumb.md
@ -15,7 +15,7 @@ export interface ChromeBreadcrumb

 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md) | <code>string</code> |  |
+|  ["data-test-subj"](./kibana-plugin-public.chromebreadcrumb._data-test-subj_.md) | <code>string</code> |  |
 |  [href](./kibana-plugin-public.chromebreadcrumb.href.md) | <code>string</code> |  |
 |  [onClick](./kibana-plugin-public.chromebreadcrumb.onclick.md) | <code>MouseEventHandler&lt;HTMLButtonElement&gt;</code> |  |
 |  [text](./kibana-plugin-public.chromebreadcrumb.text.md) | <code>string</code> |  |
--- a/docs/development/core/public/kibana-plugin-public.chromenavlinks.getforceappswitchernavigation_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromenavlinks.getforceappswitchernavigation_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLinks](./kibana-plugin-public.chromenavlinks.md) &gt; [getForceAppSwitcherNavigation$](./kibana-plugin-public.chromenavlinks.getforceappswitchernavigation$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLinks](./kibana-plugin-public.chromenavlinks.md) &gt; [getForceAppSwitcherNavigation$](./kibana-plugin-public.chromenavlinks.getforceappswitchernavigation_.md)

 ## ChromeNavLinks.getForceAppSwitcherNavigation$() method

--- a/docs/development/core/public/kibana-plugin-public.chromenavlinks.getnavlinks_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromenavlinks.getnavlinks_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLinks](./kibana-plugin-public.chromenavlinks.md) &gt; [getNavLinks$](./kibana-plugin-public.chromenavlinks.getnavlinks$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLinks](./kibana-plugin-public.chromenavlinks.md) &gt; [getNavLinks$](./kibana-plugin-public.chromenavlinks.getnavlinks_.md)

 ## ChromeNavLinks.getNavLinks$() method

--- a/docs/development/core/public/kibana-plugin-public.chromenavlinks.md
+++ b/docs/development/core/public/kibana-plugin-public.chromenavlinks.md
@ -19,8 +19,8 @@ export interface ChromeNavLinks
 |  [enableForcedAppSwitcherNavigation()](./kibana-plugin-public.chromenavlinks.enableforcedappswitchernavigation.md) | Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated. |
 |  [get(id)](./kibana-plugin-public.chromenavlinks.get.md) | Get the state of a navlink at this point in time. |
 |  [getAll()](./kibana-plugin-public.chromenavlinks.getall.md) | Get the current state of all navlinks. |
-|  [getForceAppSwitcherNavigation$()](./kibana-plugin-public.chromenavlinks.getforceappswitchernavigation$.md) | An observable of the forced app switcher state. |
-|  [getNavLinks$()](./kibana-plugin-public.chromenavlinks.getnavlinks$.md) | Get an observable for a sorted list of navlinks. |
+|  [getForceAppSwitcherNavigation$()](./kibana-plugin-public.chromenavlinks.getforceappswitchernavigation_.md) | An observable of the forced app switcher state. |
+|  [getNavLinks$()](./kibana-plugin-public.chromenavlinks.getnavlinks_.md) | Get an observable for a sorted list of navlinks. |
 |  [has(id)](./kibana-plugin-public.chromenavlinks.has.md) | Check whether or not a navlink exists. |
 |  [showOnly(id)](./kibana-plugin-public.chromenavlinks.showonly.md) | Remove all navlinks except the one matching the given id. |
 |  [update(id, values)](./kibana-plugin-public.chromenavlinks.update.md) | Update the navlink for the given id with the updated attributes. Returns the updated navlink or <code>undefined</code> if it does not exist. |
--- a/docs/development/core/public/kibana-plugin-public.chromerecentlyaccessed.get_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromerecentlyaccessed.get_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeRecentlyAccessed](./kibana-plugin-public.chromerecentlyaccessed.md) &gt; [get$](./kibana-plugin-public.chromerecentlyaccessed.get$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeRecentlyAccessed](./kibana-plugin-public.chromerecentlyaccessed.md) &gt; [get$](./kibana-plugin-public.chromerecentlyaccessed.get_.md)

 ## ChromeRecentlyAccessed.get$() method

--- a/docs/development/core/public/kibana-plugin-public.chromerecentlyaccessed.md
+++ b/docs/development/core/public/kibana-plugin-public.chromerecentlyaccessed.md
@ -18,5 +18,5 @@ export interface ChromeRecentlyAccessed
 |  --- | --- |
 |  [add(link, label, id)](./kibana-plugin-public.chromerecentlyaccessed.add.md) | Adds a new item to the recently accessed history. |
 |  [get()](./kibana-plugin-public.chromerecentlyaccessed.get.md) | Gets an Array of the current recently accessed history. |
-|  [get$()](./kibana-plugin-public.chromerecentlyaccessed.get$.md) | Gets an Observable of the array of recently accessed history. |
+|  [get$()](./kibana-plugin-public.chromerecentlyaccessed.get_.md) | Gets an Observable of the array of recently accessed history. |

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getapplicationclasses_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getapplicationclasses_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getApplicationClasses$](./kibana-plugin-public.chromestart.getapplicationclasses$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getApplicationClasses$](./kibana-plugin-public.chromestart.getapplicationclasses_.md)

 ## ChromeStart.getApplicationClasses$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getbadge_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getbadge_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBadge$](./kibana-plugin-public.chromestart.getbadge$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBadge$](./kibana-plugin-public.chromestart.getbadge_.md)

 ## ChromeStart.getBadge$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getbrand_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getbrand_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBrand$](./kibana-plugin-public.chromestart.getbrand$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBrand$](./kibana-plugin-public.chromestart.getbrand_.md)

 ## ChromeStart.getBrand$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getbreadcrumbs_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getbreadcrumbs_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBreadcrumbs$](./kibana-plugin-public.chromestart.getbreadcrumbs$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getBreadcrumbs$](./kibana-plugin-public.chromestart.getbreadcrumbs_.md)

 ## ChromeStart.getBreadcrumbs$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.gethelpextension_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.gethelpextension_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getHelpExtension$](./kibana-plugin-public.chromestart.gethelpextension$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getHelpExtension$](./kibana-plugin-public.chromestart.gethelpextension_.md)

 ## ChromeStart.getHelpExtension$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getiscollapsed_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getiscollapsed_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getIsCollapsed$](./kibana-plugin-public.chromestart.getiscollapsed$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getIsCollapsed$](./kibana-plugin-public.chromestart.getiscollapsed_.md)

 ## ChromeStart.getIsCollapsed$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.getisvisible_.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.getisvisible_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getIsVisible$](./kibana-plugin-public.chromestart.getisvisible$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [getIsVisible$](./kibana-plugin-public.chromestart.getisvisible_.md)

 ## ChromeStart.getIsVisible$() method

--- a/docs/development/core/public/kibana-plugin-public.chromestart.md
+++ b/docs/development/core/public/kibana-plugin-public.chromestart.md
@ -25,13 +25,13 @@ export interface ChromeStart
 |  Method | Description |
 |  --- | --- |
 |  [addApplicationClass(className)](./kibana-plugin-public.chromestart.addapplicationclass.md) | Add a className that should be set on the application container. |
-|  [getApplicationClasses$()](./kibana-plugin-public.chromestart.getapplicationclasses$.md) | Get the current set of classNames that will be set on the application container. |
-|  [getBadge$()](./kibana-plugin-public.chromestart.getbadge$.md) | Get an observable of the current badge |
-|  [getBrand$()](./kibana-plugin-public.chromestart.getbrand$.md) | Get an observable of the current brand information. |
-|  [getBreadcrumbs$()](./kibana-plugin-public.chromestart.getbreadcrumbs$.md) | Get an observable of the current list of breadcrumbs |
-|  [getHelpExtension$()](./kibana-plugin-public.chromestart.gethelpextension$.md) | Get an observable of the current custom help conttent |
-|  [getIsCollapsed$()](./kibana-plugin-public.chromestart.getiscollapsed$.md) | Get an observable of the current collapsed state of the chrome. |
-|  [getIsVisible$()](./kibana-plugin-public.chromestart.getisvisible$.md) | Get an observable of the current visibility state of the chrome. |
+|  [getApplicationClasses$()](./kibana-plugin-public.chromestart.getapplicationclasses_.md) | Get the current set of classNames that will be set on the application container. |
+|  [getBadge$()](./kibana-plugin-public.chromestart.getbadge_.md) | Get an observable of the current badge |
+|  [getBrand$()](./kibana-plugin-public.chromestart.getbrand_.md) | Get an observable of the current brand information. |
+|  [getBreadcrumbs$()](./kibana-plugin-public.chromestart.getbreadcrumbs_.md) | Get an observable of the current list of breadcrumbs |
+|  [getHelpExtension$()](./kibana-plugin-public.chromestart.gethelpextension_.md) | Get an observable of the current custom help conttent |
+|  [getIsCollapsed$()](./kibana-plugin-public.chromestart.getiscollapsed_.md) | Get an observable of the current collapsed state of the chrome. |
+|  [getIsVisible$()](./kibana-plugin-public.chromestart.getisvisible_.md) | Get an observable of the current visibility state of the chrome. |
 |  [removeApplicationClass(className)](./kibana-plugin-public.chromestart.removeapplicationclass.md) | Remove a className added with <code>addApplicationClass()</code>. If className is unknown it is ignored. |
 |  [setAppTitle(appTitle)](./kibana-plugin-public.chromestart.setapptitle.md) | Sets the current app's title |
 |  [setBadge(badge)](./kibana-plugin-public.chromestart.setbadge.md) | Override the current badge |
--- a/docs/development/core/public/kibana-plugin-public.fatalerrorssetup.get_.md
+++ b/docs/development/core/public/kibana-plugin-public.fatalerrorssetup.get_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) &gt; [get$](./kibana-plugin-public.fatalerrorssetup.get$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) &gt; [get$](./kibana-plugin-public.fatalerrorssetup.get_.md)

 ## FatalErrorsSetup.get$ property

--- a/docs/development/core/public/kibana-plugin-public.fatalerrorssetup.md
+++ b/docs/development/core/public/kibana-plugin-public.fatalerrorssetup.md
@ -17,5 +17,5 @@ export interface FatalErrorsSetup
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [add](./kibana-plugin-public.fatalerrorssetup.add.md) | <code>(error: string &#124; Error, source?: string) =&gt; never</code> | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. |
-|  [get$](./kibana-plugin-public.fatalerrorssetup.get$.md) | <code>() =&gt; Rx.Observable&lt;FatalErrorInfo&gt;</code> | An Observable that will emit whenever a fatal error is added with <code>add()</code> |
+|  [get$](./kibana-plugin-public.fatalerrorssetup.get_.md) | <code>() =&gt; Rx.Observable&lt;FatalErrorInfo&gt;</code> | An Observable that will emit whenever a fatal error is added with <code>add()</code> |

--- a/docs/development/core/public/kibana-plugin-public.httpservicebase.getloadingcount_.md
+++ b/docs/development/core/public/kibana-plugin-public.httpservicebase.getloadingcount_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [getLoadingCount$](./kibana-plugin-public.httpservicebase.getloadingcount$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) &gt; [getLoadingCount$](./kibana-plugin-public.httpservicebase.getloadingcount_.md)

 ## HttpServiceBase.getLoadingCount$() method

--- a/docs/development/core/public/kibana-plugin-public.httpservicebase.md
+++ b/docs/development/core/public/kibana-plugin-public.httpservicebase.md
@ -30,7 +30,7 @@ export interface HttpServiceBase
 |  Method | Description |
 |  --- | --- |
 |  [addLoadingCount(count$)](./kibana-plugin-public.httpservicebase.addloadingcount.md) |  |
-|  [getLoadingCount$()](./kibana-plugin-public.httpservicebase.getloadingcount$.md) |  |
+|  [getLoadingCount$()](./kibana-plugin-public.httpservicebase.getloadingcount_.md) |  |
 |  [intercept(interceptor)](./kibana-plugin-public.httpservicebase.intercept.md) |  |
 |  [removeAllInterceptors()](./kibana-plugin-public.httpservicebase.removeallinterceptors.md) |  |
 |  [stop()](./kibana-plugin-public.httpservicebase.stop.md) |  |
--- a/docs/development/core/public/kibana-plugin-public.simplesavedobject._constructor_.md
+++ b/docs/development/core/public/kibana-plugin-public.simplesavedobject._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [(constructor)](./kibana-plugin-public.simplesavedobject.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [(constructor)](./kibana-plugin-public.simplesavedobject._constructor_.md)

 ## SimpleSavedObject.(constructor)

--- a/docs/development/core/public/kibana-plugin-public.simplesavedobject.md
+++ b/docs/development/core/public/kibana-plugin-public.simplesavedobject.md
@ -18,7 +18,7 @@ export declare class SimpleSavedObject<T extends SavedObjectAttributes>

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion })](./kibana-plugin-public.simplesavedobject.(constructor).md) |  | Constructs a new instance of the <code>SimpleSavedObject</code> class |
+|  [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion })](./kibana-plugin-public.simplesavedobject._constructor_.md) |  | Constructs a new instance of the <code>SimpleSavedObject</code> class |

 ## Properties

--- a/docs/development/core/public/kibana-plugin-public.toastsapi._constructor_.md
+++ b/docs/development/core/public/kibana-plugin-public.toastsapi._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [(constructor)](./kibana-plugin-public.toastsapi.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [(constructor)](./kibana-plugin-public.toastsapi._constructor_.md)

 ## ToastsApi.(constructor)

--- a/docs/development/core/public/kibana-plugin-public.toastsapi.get_.md
+++ b/docs/development/core/public/kibana-plugin-public.toastsapi.get_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [get$](./kibana-plugin-public.toastsapi.get$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [get$](./kibana-plugin-public.toastsapi.get_.md)

 ## ToastsApi.get$() method

--- a/docs/development/core/public/kibana-plugin-public.toastsapi.md
+++ b/docs/development/core/public/kibana-plugin-public.toastsapi.md
@ -15,7 +15,7 @@ export declare class ToastsApi

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(deps)](./kibana-plugin-public.toastsapi.(constructor).md) |  | Constructs a new instance of the <code>ToastsApi</code> class |
+|  [(constructor)(deps)](./kibana-plugin-public.toastsapi._constructor_.md) |  | Constructs a new instance of the <code>ToastsApi</code> class |

 ## Methods

@ -26,7 +26,7 @@ export declare class ToastsApi
 |  [addError(error, options)](./kibana-plugin-public.toastsapi.adderror.md) |  |  |
 |  [addSuccess(toastOrTitle)](./kibana-plugin-public.toastsapi.addsuccess.md) |  |  |
 |  [addWarning(toastOrTitle)](./kibana-plugin-public.toastsapi.addwarning.md) |  |  |
-|  [get$()](./kibana-plugin-public.toastsapi.get$.md) |  |  |
+|  [get$()](./kibana-plugin-public.toastsapi.get_.md) |  |  |
 |  [registerOverlays(overlays)](./kibana-plugin-public.toastsapi.registeroverlays.md) |  |  |
 |  [remove(toast)](./kibana-plugin-public.toastsapi.remove.md) |  |  |

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient._constructor_.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [(constructor)](./kibana-plugin-public.uisettingsclient.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [(constructor)](./kibana-plugin-public.uisettingsclient._constructor_.md)

 ## UiSettingsClient.(constructor)

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient.get_.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient.get_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [get$](./kibana-plugin-public.uisettingsclient.get$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [get$](./kibana-plugin-public.uisettingsclient.get_.md)

 ## UiSettingsClient.get$() method

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient.getsaved_.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient.getsaved_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getSaved$](./kibana-plugin-public.uisettingsclient.getsaved$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getSaved$](./kibana-plugin-public.uisettingsclient.getsaved_.md)

 ## UiSettingsClient.getSaved$() method

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient.getupdate_.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient.getupdate_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getUpdate$](./kibana-plugin-public.uisettingsclient.getupdate$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getUpdate$](./kibana-plugin-public.uisettingsclient.getupdate_.md)

 ## UiSettingsClient.getUpdate$() method

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient.getupdateerrors_.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient.getupdateerrors_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getUpdateErrors$](./kibana-plugin-public.uisettingsclient.getupdateerrors$.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getUpdateErrors$](./kibana-plugin-public.uisettingsclient.getupdateerrors_.md)

 ## UiSettingsClient.getUpdateErrors$() method

--- a/docs/development/core/public/kibana-plugin-public.uisettingsclient.md
+++ b/docs/development/core/public/kibana-plugin-public.uisettingsclient.md
@ -15,18 +15,18 @@ export declare class UiSettingsClient

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(params)](./kibana-plugin-public.uisettingsclient.(constructor).md) |  | Constructs a new instance of the <code>UiSettingsClient</code> class |
+|  [(constructor)(params)](./kibana-plugin-public.uisettingsclient._constructor_.md) |  | Constructs a new instance of the <code>UiSettingsClient</code> class |

 ## Methods

 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [get(key, defaultOverride)](./kibana-plugin-public.uisettingsclient.get.md) |  | Gets the value for a specific uiSetting. If this setting has no user-defined value then the <code>defaultOverride</code> parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not defined by a uiSettingDefaults then an error is thrown, otherwise the default is read from the uiSettingDefaults. |
-|  [get$(key, defaultOverride)](./kibana-plugin-public.uisettingsclient.get$.md) |  | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a <code>defaultOverride</code> argument behaves the same as it does in \#get() |
+|  [get$(key, defaultOverride)](./kibana-plugin-public.uisettingsclient.get_.md) |  | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a <code>defaultOverride</code> argument behaves the same as it does in \#get() |
 |  [getAll()](./kibana-plugin-public.uisettingsclient.getall.md) |  | Gets the metadata about all uiSettings, including the type, default value, and user value for each key. |
-|  [getSaved$()](./kibana-plugin-public.uisettingsclient.getsaved$.md) |  | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. |
-|  [getUpdate$()](./kibana-plugin-public.uisettingsclient.getupdate$.md) |  | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. |
-|  [getUpdateErrors$()](./kibana-plugin-public.uisettingsclient.getupdateerrors$.md) |  | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. |
+|  [getSaved$()](./kibana-plugin-public.uisettingsclient.getsaved_.md) |  | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. |
+|  [getUpdate$()](./kibana-plugin-public.uisettingsclient.getupdate_.md) |  | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. |
+|  [getUpdateErrors$()](./kibana-plugin-public.uisettingsclient.getupdateerrors_.md) |  | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. |
 |  [isCustom(key)](./kibana-plugin-public.uisettingsclient.iscustom.md) |  | Returns true if the setting is not a part of the uiSettingDefaults, but was either added directly via <code>set()</code>, or is an unknown setting found in the uiSettings saved object |
 |  [isDeclared(key)](./kibana-plugin-public.uisettingsclient.isdeclared.md) |  | Returns true if the key is a "known" uiSetting, meaning it is either defined in the uiSettingDefaults or was previously added as a custom setting via the <code>set()</code> method. |
 |  [isDefault(key)](./kibana-plugin-public.uisettingsclient.isdefault.md) |  | Returns true if the setting has no user-defined value or is unknown |
--- a/docs/development/core/server/index.md
+++ b/docs/development/core/server/index.md
@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [kibana-plugin-server](./kibana-plugin-server.md) | The Kibana Core APIs for server-side plugins.<!-- -->A plugin requires a <code>kibana.json</code> file at it's root directory that follows  to define static plugin information required to load the plugin.<!-- -->A plugin's <code>server/index</code> file must contain a named import, <code>plugin</code>, that implements  which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either  or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
+
--- a/docs/development/core/server/kibana-plugin-server.clusterclient._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-server.clusterclient._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [(constructor)](./kibana-plugin-server.clusterclient.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [(constructor)](./kibana-plugin-server.clusterclient._constructor_.md)

 ## ClusterClient.(constructor)

--- a/docs/development/core/server/kibana-plugin-server.clusterclient.md
+++ b/docs/development/core/server/kibana-plugin-server.clusterclient.md
@ -16,7 +16,7 @@ export declare class ClusterClient

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(config, log, getAuthHeaders)](./kibana-plugin-server.clusterclient.(constructor).md) |  | Constructs a new instance of the <code>ClusterClient</code> class |
+|  [(constructor)(config, log, getAuthHeaders)](./kibana-plugin-server.clusterclient._constructor_.md) |  | Constructs a new instance of the <code>ClusterClient</code> class |

 ## Properties

--- a/docs/development/core/server/kibana-plugin-server.elasticsearcherror._code_.md
+++ b/docs/development/core/server/kibana-plugin-server.elasticsearcherror._code_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) &gt; [\[code\]](./kibana-plugin-server.elasticsearcherror.[code].md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) &gt; [\[code\]](./kibana-plugin-server.elasticsearcherror._code_.md)

 ## ElasticsearchError.\[code\] property

--- a/docs/development/core/server/kibana-plugin-server.elasticsearcherror.md
+++ b/docs/development/core/server/kibana-plugin-server.elasticsearcherror.md
@ -14,5 +14,5 @@ export interface ElasticsearchError extends Boom

 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [\[code\]](./kibana-plugin-server.elasticsearcherror.[code].md) | <code>string</code> |  |
+|  [\[code\]](./kibana-plugin-server.elasticsearcherror._code_.md) | <code>string</code> |  |

--- a/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.adminclient_.md
+++ b/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.adminclient_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) &gt; [adminClient$](./kibana-plugin-server.elasticsearchservicesetup.adminclient$.md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) &gt; [adminClient$](./kibana-plugin-server.elasticsearchservicesetup.adminclient_.md)

 ## ElasticsearchServiceSetup.adminClient$ property

--- a/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.dataclient_.md
+++ b/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.dataclient_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) &gt; [dataClient$](./kibana-plugin-server.elasticsearchservicesetup.dataclient$.md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) &gt; [dataClient$](./kibana-plugin-server.elasticsearchservicesetup.dataclient_.md)

 ## ElasticsearchServiceSetup.dataClient$ property

--- a/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.md
@ -15,8 +15,8 @@ export interface ElasticsearchServiceSetup

 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [adminClient$](./kibana-plugin-server.elasticsearchservicesetup.adminclient$.md) | <code>Observable&lt;ClusterClient&gt;</code> |  |
+|  [adminClient$](./kibana-plugin-server.elasticsearchservicesetup.adminclient_.md) | <code>Observable&lt;ClusterClient&gt;</code> |  |
 |  [createClient](./kibana-plugin-server.elasticsearchservicesetup.createclient.md) | <code>(type: string, clientConfig?: Partial&lt;ElasticsearchClientConfig&gt;) =&gt; ClusterClient</code> | Create application specific Elasticsearch cluster API client with customized config. |
-|  [dataClient$](./kibana-plugin-server.elasticsearchservicesetup.dataclient$.md) | <code>Observable&lt;ClusterClient&gt;</code> |  |
+|  [dataClient$](./kibana-plugin-server.elasticsearchservicesetup.dataclient_.md) | <code>Observable&lt;ClusterClient&gt;</code> |  |
 |  [legacy](./kibana-plugin-server.elasticsearchservicesetup.legacy.md) | <code>{</code><br/><code>        readonly config$: Observable&lt;ElasticsearchConfig&gt;;</code><br/><code>    }</code> |  |

--- a/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate.md
+++ b/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate.md
@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) &gt; [getPeerCertificate](./kibana-plugin-server.ikibanasocket.getpeercertificate.md)
+
+## IKibanaSocket.getPeerCertificate() method
+
+<b>Signature:</b>
+
+```typescript
+getPeerCertificate(detailed: true): DetailedPeerCertificate | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  detailed | <code>true</code> |  |
+
+<b>Returns:</b>
+
+`DetailedPeerCertificate | null`
+
--- a/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_1.md
+++ b/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_1.md
@ -7,16 +7,16 @@
 <b>Signature:</b>

 ```typescript
-getPeerCertificate(detailed: true): DetailedPeerCertificate | null;
+getPeerCertificate(detailed: false): PeerCertificate | null;
 ```

 ## Parameters

 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  detailed | <code>true</code> |  |
+|  detailed | <code>false</code> |  |

 <b>Returns:</b>

-`DetailedPeerCertificate | null`
+`PeerCertificate | null`

--- a/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_2.md
+++ b/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_2.md
@ -4,19 +4,23 @@

 ## IKibanaSocket.getPeerCertificate() method

+Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null.
+
 <b>Signature:</b>

 ```typescript
-getPeerCertificate(detailed: false): PeerCertificate | null;
+getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null;
 ```

 ## Parameters

 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  detailed | <code>false</code> |  |
+|  detailed | <code>boolean</code> | If true; the full chain with issuer property will be returned. |

 <b>Returns:</b>

-`PeerCertificate | null`
+`PeerCertificate | DetailedPeerCertificate | null`
+
+An object representing the peer's certificate.

--- a/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_3.md
+++ b/docs/development/core/server/kibana-plugin-server.ikibanasocket.getpeercertificate_3.md
@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) &gt; [getPeerCertificate](./kibana-plugin-server.ikibanasocket.getpeercertificate_3.md)
-
-## IKibanaSocket.getPeerCertificate() method
-
-Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null.
-
-<b>Signature:</b>
-
-```typescript
-getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  detailed | <code>boolean</code> | If true; the full chain with issuer property will be returned. |
-
-<b>Returns:</b>
-
-`PeerCertificate | DetailedPeerCertificate | null`
-
-An object representing the peer's certificate.
-
--- a/docs/development/core/server/kibana-plugin-server.ikibanasocket.md
+++ b/docs/development/core/server/kibana-plugin-server.ikibanasocket.md
@ -23,7 +23,7 @@ export interface IKibanaSocket

 |  Method | Description |
 |  --- | --- |
+|  [getPeerCertificate(detailed)](./kibana-plugin-server.ikibanasocket.getpeercertificate.md) |  |
 |  [getPeerCertificate(detailed)](./kibana-plugin-server.ikibanasocket.getpeercertificate_1.md) |  |
-|  [getPeerCertificate(detailed)](./kibana-plugin-server.ikibanasocket.getpeercertificate_2.md) |  |
-|  [getPeerCertificate(detailed)](./kibana-plugin-server.ikibanasocket.getpeercertificate_3.md) | Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. |
+|  [getPeerCertificate(detailed)](./kibana-plugin-server.ikibanasocket.getpeercertificate_2.md) | Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. |

--- a/docs/development/core/server/kibana-plugin-server.kibanarequest._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-server.kibanarequest._constructor_.md
@ -1,6 +1,6 @@
 <!-- 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; [(constructor)](./kibana-plugin-server.kibanarequest.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequest](./kibana-plugin-server.kibanarequest.md) &gt; [(constructor)](./kibana-plugin-server.kibanarequest._constructor_.md)

 ## KibanaRequest.(constructor)

--- a/docs/development/core/server/kibana-plugin-server.kibanarequest.md
+++ b/docs/development/core/server/kibana-plugin-server.kibanarequest.md
@ -16,7 +16,7 @@ export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unk

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(request, params, query, body, withoutSecretHeaders)](./kibana-plugin-server.kibanarequest.(constructor).md) |  | Constructs a new instance of the <code>KibanaRequest</code> class |
+|  [(constructor)(request, params, query, body, withoutSecretHeaders)](./kibana-plugin-server.kibanarequest._constructor_.md) |  | Constructs a new instance of the <code>KibanaRequest</code> class |

 ## Properties

--- a/docs/development/core/server/kibana-plugin-server.kibanaresponsefactory.md
+++ b/docs/development/core/server/kibana-plugin-server.kibanaresponsefactory.md
@ -1,13 +1,118 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaResponseFactory](./kibana-plugin-server.kibanaresponsefactory.md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [kibanaResponseFactory](./kibana-plugin-server.kibanaresponsefactory.md)

-## KibanaResponseFactory type
+## kibanaResponseFactory variable

-Creates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client.
+Set of helpers used to create `KibanaResponse` to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-server.requesthandler.md) execution.

 <b>Signature:</b>

 ```typescript
-export declare type KibanaResponseFactory = typeof kibanaResponseFactory;
+kibanaResponseFactory: {
+    custom: <T extends string | Error | Record<string, any> | Buffer | Stream | {
+        message: string | Error;
+        attributes?: Record<string, any> | undefined;
+    } | undefined>(options: CustomHttpResponseOptions<T>) => KibanaResponse<T>;
+    badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    internalError: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>;
+    customError: (options: CustomHttpResponseOptions<ResponseError>) => KibanaResponse<ResponseError>;
+    redirected: (options: RedirectResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>;
+    ok: (options?: HttpResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>;
+    accepted: (options?: HttpResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>;
+    noContent: (options?: HttpResponseOptions) => KibanaResponse<undefined>;
+}
 ```
+
+## Example
+
+1. Successful response. Supported types of response body are: - `undefined`<!-- -->, no content to send. - `string`<!-- -->, send text - `JSON`<!-- -->, send JSON object, HTTP server will throw if given object is not valid (has circular references, for example) - `Stream` send data stream - `Buffer` send binary stream
+
+```js
+return response.ok();
+return response.ok({ body: 'ack' });
+return response.ok({ body: { id: '1' } });
+return response.ok({ body: Buffer.from(...) });
+
+const stream = new Stream.PassThrough();
+fs.createReadStream('./file').pipe(stream);
+return res.ok({ body: stream });
+
+```
+HTTP headers are configurable via response factory parameter `options` [HttpResponseOptions](./kibana-plugin-server.httpresponseoptions.md)<!-- -->.
+
+```js
+return response.ok({
+  body: { id: '1' },
+  headers: {
+    'content-type': 'application/json'
+  }
+});
+
+```
+2. Redirection response. Redirection URL is configures via 'Location' header.
+
+```js
+return response.redirected({
+  body: 'The document has moved',
+  headers: {
+   location: '/new-url',
+  },
+});
+
+```
+3. Error response. You may pass an error message to the client, where error message can be: - `string` send message text - `Error` send the message text of given Error object. - `{ message: string | Error, attributes: {data: Record<string, any>, ...} }` - send message text and attach additional error data.
+
+```js
+return response.unauthorized({
+  body: 'User has no access to the requested resource.',
+  headers: {
+    'WWW-Authenticate': 'challenge',
+  }
+})
+return response.badRequest();
+return response.badRequest({ body: 'validation error' });
+
+try {
+  // ...
+} catch(error){
+  return response.badRequest({ body: error });
+}
+
+return response.badRequest({
+ body:{
+   message: 'validation error',
+   attributes: {
+     requestBody: request.body,
+     failedFields: validationResult
+   }
+ }
+});
+
+try {
+  // ...
+} catch(error) {
+  return response.badRequest({
+    body: error
+  });
+}
+
+
+```
+4. Custom response. `ResponseFactory` may not cover your use case, so you can use the `custom` function to customize the response.
+
+```js
+return response.custom({
+  body: 'ok',
+  statusCode: 201,
+  headers: {
+    location: '/created-url'
+  }
+})
+
+```
+
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsschema._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsschema._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsSchema](./kibana-plugin-server.savedobjectsschema.md) &gt; [(constructor)](./kibana-plugin-server.savedobjectsschema.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsSchema](./kibana-plugin-server.savedobjectsschema.md) &gt; [(constructor)](./kibana-plugin-server.savedobjectsschema._constructor_.md)

 ## SavedObjectsSchema.(constructor)

--- a/docs/development/core/server/kibana-plugin-server.savedobjectsschema.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsschema.md
@ -14,7 +14,7 @@ export declare class SavedObjectsSchema

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(schemaDefinition)](./kibana-plugin-server.savedobjectsschema.(constructor).md) |  | Constructs a new instance of the <code>SavedObjectsSchema</code> class |
+|  [(constructor)(schemaDefinition)](./kibana-plugin-server.savedobjectsschema._constructor_.md) |  | Constructs a new instance of the <code>SavedObjectsSchema</code> class |

 ## Methods

--- a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) &gt; [(constructor)](./kibana-plugin-server.savedobjectsserializer.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) &gt; [(constructor)](./kibana-plugin-server.savedobjectsserializer._constructor_.md)

 ## SavedObjectsSerializer.(constructor)

--- a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.md
@ -14,7 +14,7 @@ export declare class SavedObjectsSerializer

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(schema)](./kibana-plugin-server.savedobjectsserializer.(constructor).md) |  | Constructs a new instance of the <code>SavedObjectsSerializer</code> class |
+|  [(constructor)(schema)](./kibana-plugin-server.savedobjectsserializer._constructor_.md) |  | Constructs a new instance of the <code>SavedObjectsSerializer</code> class |

 ## Methods

--- a/docs/development/core/server/kibana-plugin-server.scopedclusterclient._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-server.scopedclusterclient._constructor_.md
@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->

-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) &gt; [(constructor)](./kibana-plugin-server.scopedclusterclient.(constructor).md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) &gt; [(constructor)](./kibana-plugin-server.scopedclusterclient._constructor_.md)

 ## ScopedClusterClient.(constructor)

--- a/docs/development/core/server/kibana-plugin-server.scopedclusterclient.md
+++ b/docs/development/core/server/kibana-plugin-server.scopedclusterclient.md
@ -16,7 +16,7 @@ export declare class ScopedClusterClient

 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(internalAPICaller, scopedAPICaller, headers)](./kibana-plugin-server.scopedclusterclient.(constructor).md) |  | Constructs a new instance of the <code>ScopedClusterClient</code> class |
+|  [(constructor)(internalAPICaller, scopedAPICaller, headers)](./kibana-plugin-server.scopedclusterclient._constructor_.md) |  | Constructs a new instance of the <code>ScopedClusterClient</code> class |

 ## Methods

--- a/package.json
+++ b/package.json
@ -280,8 +280,8 @@
    "@kbn/plugin-generator": "1.0.0",
    "@kbn/test": "1.0.0",
    "@kbn/utility-types": "1.0.0",
-    "@microsoft/api-documenter": "7.2.1",
-    "@microsoft/api-extractor": "7.1.8",
+    "@microsoft/api-documenter": "7.4.3",
+    "@microsoft/api-extractor": "7.4.2",
    "@octokit/rest": "^15.10.0",
    "@percy/agent": "^0.11.0",
    "@types/angular": "1.6.50",
--- a/yarn.lock
+++ b/yarn.lock
@ -1972,55 +1972,47 @@
    utils-error-reviver "^1.0.0"
    utils-error-to-json "^1.0.0"

-"@microsoft/api-documenter@7.2.1":
-  version "7.2.1"
-  resolved "https://registry.yarnpkg.com/@microsoft/api-documenter/-/api-documenter-7.2.1.tgz#560d5649dec87cf0227ffe7ba6df4c96533ca75d"
-  integrity sha512-o5SjVRovTWL9NwZdQimhXdWEKkYdxlrRDy+Y4GDvx9R5vObS2ptKZoC0bdHT5R9Febw9I/io8YVcQOzFHxKuqw==
+"@microsoft/api-documenter@7.4.3":
+  version "7.4.3"
+  resolved "https://registry.yarnpkg.com/@microsoft/api-documenter/-/api-documenter-7.4.3.tgz#af5e69891c4b62e963a697127b69a25396d0123d"
+  integrity sha512-+RdqNNt9ssUCBAsLvKVPzbRD5RYd0HRgmnhRuEr+eZg2tj2tqfP9AhLWK5SBVn68CX5hyeWHEnQJ4HikDTZN8A==
  dependencies:
-    "@microsoft/api-extractor-model" "7.1.1"
-    "@microsoft/node-core-library" "3.13.0"
-    "@microsoft/ts-command-line" "4.2.5"
-    "@microsoft/tsdoc" "0.12.9"
+    "@microsoft/api-extractor-model" "7.4.1"
+    "@microsoft/node-core-library" "3.14.2"
+    "@microsoft/ts-command-line" "4.2.8"
+    "@microsoft/tsdoc" "0.12.14"
    colors "~1.2.1"
    js-yaml "~3.13.1"
+    resolve "1.8.1"

-"@microsoft/api-extractor-model@7.1.1":
-  version "7.1.1"
-  resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.1.1.tgz#17aa30fe641db7efbcfb779f4a87b8461d6a2322"
-  integrity sha512-RiQJA8JpBbRxqUfro8SxZGLjeCFH8HUUJvD5VTUrDrgdt13omx7d0bsGN0lf+AT63yF+RX4R2+Jd2b0SaAO/sQ==
+"@microsoft/api-extractor-model@7.4.1":
+  version "7.4.1"
+  resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.4.1.tgz#3376f72570d336960c9b7b0dd44c8a0dbbe34604"
+  integrity sha512-rBO/QbrOMCdL8e9qwhIu1aH4C5sKOnUO1YhEh3+kVieFzTjiRnync7ghyQOtCaCVl2VXtp4LuOIv02e82oRqUg==
  dependencies:
-    "@microsoft/node-core-library" "3.13.0"
-    "@microsoft/tsdoc" "0.12.9"
+    "@microsoft/node-core-library" "3.14.2"
+    "@microsoft/tsdoc" "0.12.14"
    "@types/node" "8.5.8"

-"@microsoft/api-extractor-model@7.1.3":
-  version "7.1.3"
-  resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.1.3.tgz#f74d86e0aa838614daa2ffe1f743595061b85fed"
-  integrity sha512-DjagaoMFY1XyLjjo/x4lp7LoyjyMg4ntDY5+RE8g2zvt61m2dKm9CtxW0lxaQI4Xilw+n+Z4exjcGaQJeRcMyw==
+"@microsoft/api-extractor@7.4.2":
+  version "7.4.2"
+  resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.4.2.tgz#440023cf05c69840e054cdb5f85cab9680227a40"
+  integrity sha512-O8OEaFvsvWEuwkOcVyWegIAFDY6TBZBvSIoOKLsSQYiQZtryGf13e2ym83iewhbUN7RmuOJtyQUKlBvcJbpgQA==
  dependencies:
-    "@microsoft/node-core-library" "3.13.0"
-    "@microsoft/tsdoc" "0.12.9"
-    "@types/node" "8.5.8"
-
-"@microsoft/api-extractor@7.1.8":
-  version "7.1.8"
-  resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.1.8.tgz#c5bd4bfef29d462920fcf29ac9838a7d7529afb7"
-  integrity sha512-7fcGbnOp7bmQe4p1b123K6gJ/qyaLWhufSt5OF3DMMK1JbmdfEGWf7AwyFFSS4QQzPvSxqs8Woehye4Ytf1uAA==
-  dependencies:
-    "@microsoft/api-extractor-model" "7.1.3"
-    "@microsoft/node-core-library" "3.13.0"
-    "@microsoft/ts-command-line" "4.2.5"
-    "@microsoft/tsdoc" "0.12.9"
+    "@microsoft/api-extractor-model" "7.4.1"
+    "@microsoft/node-core-library" "3.14.2"
+    "@microsoft/ts-command-line" "4.2.8"
+    "@microsoft/tsdoc" "0.12.14"
    colors "~1.2.1"
-    lodash "~4.17.5"
+    lodash "~4.17.15"
    resolve "1.8.1"
    source-map "~0.6.1"
-    typescript "~3.4.3"
+    typescript "~3.5.3"

-"@microsoft/node-core-library@3.13.0":
-  version "3.13.0"
-  resolved "https://registry.yarnpkg.com/@microsoft/node-core-library/-/node-core-library-3.13.0.tgz#ba24e16182149dc817bf52a886d22aced5cd8070"
-  integrity sha512-mnsL/1ikVWHl8sPNssavaAgtUaIM3hkQ8zeySuApU5dNmsMPzovJPfx9m5JGiMvs1v5QNAIVeiS9jnWwe/7anw==
+"@microsoft/node-core-library@3.14.2":
+  version "3.14.2"
+  resolved "https://registry.yarnpkg.com/@microsoft/node-core-library/-/node-core-library-3.14.2.tgz#255d421963f2d447a19f935e3c8eb3053e8e381b"
+  integrity sha512-bd8XhqhIvXsWg/SSNsZJdJxkN8Ucj7XKQkRe4cdYiKqpVdAREvW/shw8AoZIdgvjLI53029I/MO2Wn/AjGD3Jw==
  dependencies:
    "@types/fs-extra" "5.0.4"
    "@types/jju" "~1.4.0"
@ -2031,20 +2023,20 @@
    jju "~1.4.0"
    z-schema "~3.18.3"

-"@microsoft/ts-command-line@4.2.5":
-  version "4.2.5"
-  resolved "https://registry.yarnpkg.com/@microsoft/ts-command-line/-/ts-command-line-4.2.5.tgz#ef5060c841e2e604c1e51c68f1b890a9b75ec6ff"
-  integrity sha512-QyTfbfpx6o+1cnjx5GubqKSRMDxBBMXABSa8wmqRa/A1K99FEBZfLIO6GmaY0s7rNYEchfR1VcVS/hV2VW+6hw==
+"@microsoft/ts-command-line@4.2.8":
+  version "4.2.8"
+  resolved "https://registry.yarnpkg.com/@microsoft/ts-command-line/-/ts-command-line-4.2.8.tgz#92f4c85d0a4b893090fe6605f255e272b270495e"
+  integrity sha512-K4sc8/OJ/y5uQPWJFACMExS2UIqF+t3vdQ2A9Mhl9tMsp70CXf0sp6Y9ENYju1K7XWwR5Clh8dkP2jO1Ntlg1g==
  dependencies:
    "@types/argparse" "1.0.33"
    "@types/node" "8.5.8"
    argparse "~1.0.9"
    colors "~1.2.1"

-"@microsoft/tsdoc@0.12.9":
-  version "0.12.9"
-  resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.12.9.tgz#f92538bebf649b1b9d00bdd34a9c9971aef17d01"
-  integrity sha512-sDhulvuVk65eMppYOE6fr6mMI6RUqs53KUg9deYzNCBpP+2FhR0OFB5innEfdtSedk0LK+1Ppu6MxkfiNjS/Cw==
+"@microsoft/tsdoc@0.12.14":
+  version "0.12.14"
+  resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.12.14.tgz#0e0810a0a174e50e22dfe8edb30599840712f22d"
+  integrity sha512-518yewjSga1jLdiLrcmpMFlaba5P+50b0TWNFUpC+SL9Yzf0kMi57qw+bMl+rQ08cGqH1vLx4eg9YFUbZXgZ0Q==

 "@mrmlnc/readdir-enhanced@^2.2.1":
  version "2.2.1"
@ -18435,7 +18427,7 @@ lodash@4.17.13, lodash@4.17.15:
  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.13.tgz#0bdc3a6adc873d2f4e0c4bac285df91b64fc7b93"
  integrity sha512-vm3/XWXfWtRua0FkUyEHBZy8kCPjErNBT9fJx8Zvs+U6zjqPbTUOpkaoum3O5uiA8sm+yNMHXfYkTUHFoMxFNA==

-lodash@>4.17.4, lodash@^4.0.0, lodash@^4.0.1, lodash@^4.10.0, lodash@^4.11.1, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.15.0, lodash@^4.16.4, lodash@^4.17.0, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.15, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.0, lodash@^4.2.1, lodash@^4.3.0, lodash@^4.5.0, lodash@^4.6.1, lodash@~4.17.10, lodash@~4.17.5:
+lodash@>4.17.4, lodash@^4.0.0, lodash@^4.0.1, lodash@^4.10.0, lodash@^4.11.1, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.15.0, lodash@^4.16.4, lodash@^4.17.0, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.15, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.0, lodash@^4.2.1, lodash@^4.3.0, lodash@^4.5.0, lodash@^4.6.1, lodash@~4.17.10, lodash@~4.17.15, lodash@~4.17.5:
  version "4.17.15"
  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
  integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
@ -28085,7 +28077,7 @@ typescript-fsa@^2.0.0, typescript-fsa@^2.5.0:
  resolved "https://registry.yarnpkg.com/typescript-fsa/-/typescript-fsa-2.5.0.tgz#1baec01b5e8f5f34c322679d1327016e9e294faf"
  integrity sha1-G67AG16PXzTDImedEycBbp4pT68=

-typescript@3.5.1, typescript@3.5.3, typescript@^3.0.1, typescript@^3.0.3, typescript@^3.3.3333, typescript@^3.4.5, typescript@~3.0.3, typescript@~3.3.3333, typescript@~3.4.3:
+typescript@3.5.1, typescript@3.5.3, typescript@^3.0.1, typescript@^3.0.3, typescript@^3.3.3333, typescript@^3.4.5, typescript@~3.0.3, typescript@~3.3.3333, typescript@~3.5.3:
  version "3.5.3"
  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.5.3.tgz#c830f657f93f1ea846819e929092f5fe5983e977"
  integrity sha512-ACzBtm/PhXBDId6a6sDJfroT2pOWt/oOnk4/dElG5G33ZL776N3Y6/6bKZJBFpd+b05F3Ct9qDjMeJmRWtE2/g==