public/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. 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. |
+| [kibana-plugin-core-public](./kibana-plugin-core-public.md) | The Kibana Core APIs for client-side plugins.
A plugin's public/index file must contain a named import, plugin, that implements which returns an object that implements .
The plugin integrates with the core system via lifecycle events: setup, start, and stop. 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.
/app/${id}. Must be unique across registered applications. Should not include the base path from HTTP. |
-| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | Partial<Capabilities> | (Optional) Custom capabilities defined by the app. |
-| [category?](./kibana-plugin-core-public.app.category.md) | AppCategory | (Optional) The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
-| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | boolean | (Optional) Hide the UI chrome when the application is mounted. Defaults to false. Takes precedence over chrome service visibility settings. |
-| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | AppDeepLink\[\] | (Optional) Input type for registering secondary in-app locations for an application.Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
-| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | string | (Optional) Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the path option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
-| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | boolean | (Optional) If set to true, the application's route will only be checked against an exact match. Defaults to false. |
-| [id](./kibana-plugin-core-public.app.id.md) | string | The unique identifier of the application.Can only be composed of alphanumeric characters, -, : and _ |
-| [keywords?](./kibana-plugin-core-public.app.keywords.md) | string\[\] | (Optional) Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. |
-| [mount](./kibana-plugin-core-public.app.mount.md) | AppMount<HistoryLocationState> | A mount function called when the user navigates to this app's route. |
-| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | AppNavLinkStatus | (Optional) The initial status of the application's navLink. Defaulting to visible if status is accessible and hidden if status is inaccessible See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
-| [searchable?](./kibana-plugin-core-public.app.searchable.md) | boolean | (Optional) The initial flag to determine if the application is searchable in the global search. Defaulting to true if navLinkStatus is visible or omitted. |
-| [status?](./kibana-plugin-core-public.app.status.md) | AppStatus | (Optional) The initial status of the application. Defaulting to accessible |
-| [title](./kibana-plugin-core-public.app.title.md) | string | The title of the application. |
-| [updater$?](./kibana-plugin-core-public.app.updater_.md) | Observable<AppUpdater> | (Optional) An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [appRoute?](./kibana-plugin-core-public.app.approute.md) | | string | _(Optional)_ Override the application's routing path from /app/${id}. Must be unique across registered applications. Should not include the base path from HTTP. |
+| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | | Partial<Capabilities> | _(Optional)_ Custom capabilities defined by the app. |
+| [category?](./kibana-plugin-core-public.app.category.md) | | AppCategory | _(Optional)_ The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
+| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | | boolean | _(Optional)_ Hide the UI chrome when the application is mounted. Defaults to false. Takes precedence over chrome service visibility settings. |
+| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | | AppDeepLink\[\] | _(Optional)_ Input type for registering secondary in-app locations for an application.
Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
path option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
+| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | | boolean | _(Optional)_ If set to true, the application's route will only be checked against an exact match. Defaults to false. |
+| [id](./kibana-plugin-core-public.app.id.md) | | string | The unique identifier of the application.
Can only be composed of alphanumeric characters, -, : and _
visible if status is accessible and hidden if status is inaccessible See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
+| [searchable?](./kibana-plugin-core-public.app.searchable.md) | | boolean | _(Optional)_ The initial flag to determine if the application is searchable in the global search. Defaulting to true if navLinkStatus is visible or omitted. |
+| [status?](./kibana-plugin-core-public.app.status.md) | | AppStatus | _(Optional)_ The initial status of the application. Defaulting to accessible |
+| [title](./kibana-plugin-core-public.app.title.md) | | string | The title of the application. |
+| [updater$?](./kibana-plugin-core-public.app.updater_.md) | | Observable<AppUpdater> | _(Optional)_ An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.app.mount.md b/docs/development/core/public/kibana-plugin-core-public.app.mount.md
index 460ded2a4bff1..22efa54e7019a 100644
--- a/docs/development/core/public/kibana-plugin-core-public.app.mount.md
+++ b/docs/development/core/public/kibana-plugin-core-public.app.mount.md
@@ -6,7 +6,7 @@
A mount function called when the user navigates to this app's route.
-Signature:
+**Signature:**
```typescript
mount: AppMountupdater$ property of the registered application instead. |
+| [registerAppUpdater(appUpdater$)](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) | Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) fields of all applications at runtime.
This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the updater$ property of the registered application instead.
/basePath/app/my-app). Use the absolute option to generate an absolute url instead (e.g http://host:port/basePath/app/my-app)Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. |
+| [getUrlForApp(appId, options)](./kibana-plugin-core-public.applicationstart.geturlforapp.md) | Returns the absolute path (or URL) to a given app, including the global base path.
By default, it returns the absolute path of the application (e.g /basePath/app/my-app). Use the absolute option to generate an absolute url instead (e.g http://host:port/basePath/app/my-app)
Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location.
| | [navigateToApp(appId, options)](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | Navigate to a given app | -| [navigateToUrl(url)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).The method resolves pathnames the same way browsers do when resolving a<a href> value. The provided url can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app/appRoute configuration)Then a SPA navigation will be performed using navigateToApp using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using window.location.assign |
+| [navigateToUrl(url)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).
The method resolves pathnames the same way browsers do when resolving a <a href> value. The provided url can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)
If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app/appRoute configuration)
Then a SPA navigation will be performed using navigateToApp using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using window.location.assign
undefined will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | | string | The route path for configuring navigation to the application. This string should not include the base path from HTTP. |
+| [element](./kibana-plugin-core-public.appmountparameters.element.md) | | HTMLElement | The container element to render the application into. |
+| [history](./kibana-plugin-core-public.appmountparameters.history.md) | | ScopedHistory<HistoryLocationState> | A scoped history instance for your application. Should be used to wire up your applications Router. |
+| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | | (handler: AppLeaveHandler) => void | A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page.
This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url.
| +| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | | (menuMount: MountPoint \| undefined) => void |A function that can be used to set the mount point used to populate the application action container in the chrome header.
Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with undefined will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect.
icon property. |
-| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. |
-| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. |
-| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | string | (Optional) A tooltip shown when hovering over app link. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [euiIconType?](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | | string | _(Optional)_ A EUI iconType that will be used for the app's icon. This icon takes precendence over the icon property. |
+| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | | string | _(Optional)_ A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. |
+| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | | number | _(Optional)_ An ordinal used to sort nav links relative to one another for display. |
+| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | | string | _(Optional)_ A tooltip shown when hovering over app link. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md
index ca7ae482a04ad..ef3955c22246f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md
+++ b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md
@@ -6,7 +6,7 @@
An ordinal used to sort nav links relative to one another for display.
-Signature:
+**Signature:**
```typescript
order?: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md
index 97c18c2e56a1e..cd15aab651dd7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md
+++ b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md
@@ -6,7 +6,7 @@
A tooltip shown when hovering over app link.
-Signature:
+**Signature:**
```typescript
tooltip?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.appstatus.md b/docs/development/core/public/kibana-plugin-core-public.appstatus.md
index 438d6d7d4728b..2239912064470 100644
--- a/docs/development/core/public/kibana-plugin-core-public.appstatus.md
+++ b/docs/development/core/public/kibana-plugin-core-public.appstatus.md
@@ -6,7 +6,7 @@
Accessibility status of an application.
-Signature:
+**Signature:**
```typescript
export declare enum AppStatus
diff --git a/docs/development/core/public/kibana-plugin-core-public.appunmount.md b/docs/development/core/public/kibana-plugin-core-public.appunmount.md
index 1c066f67a8ffe..e24daabf017a6 100644
--- a/docs/development/core/public/kibana-plugin-core-public.appunmount.md
+++ b/docs/development/core/public/kibana-plugin-core-public.appunmount.md
@@ -6,7 +6,7 @@
A function called when an application should be unmounted from the page. This function should be synchronous.
-Signature:
+**Signature:**
```typescript
export declare type AppUnmount = () => void;
diff --git a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md b/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md
index c24da05abe7ec..6f912a85740a8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md
+++ b/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md
@@ -6,7 +6,7 @@
Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md).
-Signature:
+**Signature:**
```typescript
export declare type AppUpdatableFields = Pickchildren) |
-| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | string | URL of the link |
-| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | 'custom' | Extend EuiButtonEmpty to provide extra functionality |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | | React.ReactNode | Content of the button (in lieu of children) |
+| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | | string | URL of the link |
+| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | | 'custom' | Extend EuiButtonEmpty to provide extra functionality |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md
index b6714c39a4699..fa9b401dc1cec 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md
@@ -6,7 +6,7 @@
URL to discuss page. i.e. `https://discuss.elastic.co/c/${appName}`
-Signature:
+**Signature:**
```typescript
href: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md
index 0141677b26a40..cc8e1005619d3 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md
@@ -6,7 +6,7 @@
Creates a generic give feedback link with comment icon
-Signature:
+**Signature:**
```typescript
linkType: 'discuss';
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md
index 3dc32fcb6d87f..9dc218dd272d1 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md
@@ -5,17 +5,17 @@
## ChromeHelpExtensionMenuDiscussLink interface
-Signature:
+**Signature:**
```typescript
export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase
```
-Extends: ChromeHelpExtensionLinkBase
+**Extends:** ChromeHelpExtensionLinkBase
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | string | URL to discuss page. i.e. https://discuss.elastic.co/c/${appName} |
-| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | 'discuss' | Creates a generic give feedback link with comment icon |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | | string | URL to discuss page. i.e. https://discuss.elastic.co/c/${appName} |
+| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | | 'discuss' | Creates a generic give feedback link with comment icon |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md
index 9897bc6fcd2f7..ee04ecbc003f6 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md
@@ -6,7 +6,7 @@
URL to documentation page. i.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`,
-Signature:
+**Signature:**
```typescript
href: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md
index b75a70f9518b3..620acf70fc05d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md
@@ -6,7 +6,7 @@
Creates a deep-link to app-specific documentation
-Signature:
+**Signature:**
```typescript
linkType: 'documentation';
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md
index d20b513b1c550..b16c1111dbab8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md
@@ -5,17 +5,17 @@
## ChromeHelpExtensionMenuDocumentationLink interface
-Signature:
+**Signature:**
```typescript
export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase
```
-Extends: ChromeHelpExtensionLinkBase
+**Extends:** ChromeHelpExtensionLinkBase
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | string | URL to documentation page. i.e. ${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html, |
-| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | 'documentation' | Creates a deep-link to app-specific documentation |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | | string | URL to documentation page. i.e. ${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html, |
+| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | | 'documentation' | Creates a deep-link to app-specific documentation |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md
index 1976215e7243c..0519f3ae4b1fd 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md
@@ -6,7 +6,7 @@
Include at least one app-specific label to be applied to the new github issue
-Signature:
+**Signature:**
```typescript
labels: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md
index b3df27213e5b7..b3f78e5768e18 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md
@@ -6,7 +6,7 @@
Creates a link to a new github issue in the Kibana repo
-Signature:
+**Signature:**
```typescript
linkType: 'github';
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md
index 56eee43d26902..2af60ab06ed1b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md
@@ -5,18 +5,18 @@
## ChromeHelpExtensionMenuGitHubLink interface
-Signature:
+**Signature:**
```typescript
export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase
```
-Extends: ChromeHelpExtensionLinkBase
+**Extends:** ChromeHelpExtensionLinkBase
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | string\[\] | Include at least one app-specific label to be applied to the new github issue |
-| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | 'github' | Creates a link to a new github issue in the Kibana repo |
-| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | string | (Optional) Provides initial text for the title of the issue |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | | string\[\] | Include at least one app-specific label to be applied to the new github issue |
+| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | | 'github' | Creates a link to a new github issue in the Kibana repo |
+| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | | string | _(Optional)_ Provides initial text for the title of the issue |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md
index af6091f9e7252..b7fafada9bf3f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md
@@ -6,7 +6,7 @@
Provides initial text for the title of the issue
-Signature:
+**Signature:**
```typescript
title?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md
index cb7d795e3eb8e..0ed188f34f7fa 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md
@@ -5,7 +5,7 @@
## ChromeHelpExtensionMenuLink type
-Signature:
+**Signature:**
```typescript
export declare type ChromeHelpExtensionMenuLink = ChromeHelpExtensionMenuGitHubLink | ChromeHelpExtensionMenuDiscussLink | ChromeHelpExtensionMenuDocumentationLink | ChromeHelpExtensionMenuCustomLink;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md
index c0371078c28a4..93d08f67192e1 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md
@@ -5,7 +5,7 @@
## ChromeNavControl interface
-Signature:
+**Signature:**
```typescript
export interface ChromeNavControl
@@ -13,8 +13,8 @@ export interface ChromeNavControl
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | MountPoint | |
-| [order?](./kibana-plugin-core-public.chromenavcontrol.order.md) | number | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | | MountPoint | |
+| [order?](./kibana-plugin-core-public.chromenavcontrol.order.md) | | number | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md
index 911fbe2131b52..e1a54d14452e3 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md
@@ -4,7 +4,7 @@
## ChromeNavControl.mount property
-Signature:
+**Signature:**
```typescript
mount: MountPoint;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md
index ca6d865a68e4b..08ff0ab2ac48c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md
@@ -4,7 +4,7 @@
## ChromeNavControl.order property
-Signature:
+**Signature:**
```typescript
order?: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md
index 72018d46428a4..f85c44904f835 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md
@@ -6,7 +6,7 @@
[APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar.
-Signature:
+**Signature:**
```typescript
export interface ChromeNavControls
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md
index 68b243bf47f85..f5a0988bb4dfe 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md
@@ -6,7 +6,7 @@
Register a nav control to be presented on the top-center side of the chrome header.
-Signature:
+**Signature:**
```typescript
registerCenter(navControl: ChromeNavControl): void;
@@ -18,7 +18,7 @@ registerCenter(navControl: ChromeNavControl): void;
| --- | --- | --- |
| navControl | ChromeNavControl | |
-Returns:
+**Returns:**
void
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md
index ee0789c285f0b..369b628d627b9 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md
@@ -6,7 +6,7 @@
Register a nav control to be presented on the bottom-left side of the chrome header.
-Signature:
+**Signature:**
```typescript
registerLeft(navControl: ChromeNavControl): void;
@@ -18,7 +18,7 @@ registerLeft(navControl: ChromeNavControl): void;
| --- | --- | --- |
| navControl | ChromeNavControl | |
-Returns:
+**Returns:**
void
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md
index 9091736c62eeb..eac6f4acf8ff4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md
@@ -6,7 +6,7 @@
Register a nav control to be presented on the top-right side of the chrome header.
-Signature:
+**Signature:**
```typescript
registerRight(navControl: ChromeNavControl): void;
@@ -18,7 +18,7 @@ registerRight(navControl: ChromeNavControl): void;
| --- | --- | --- |
| navControl | ChromeNavControl | |
-Returns:
+**Returns:**
void
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md
index 88dc54cf823b9..6ab98217b2d9d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md
@@ -6,7 +6,7 @@
The base route used to open the root of an application.
-Signature:
+**Signature:**
```typescript
readonly baseUrl: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md
index 1da313365f967..07aa0153a717f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md
@@ -6,7 +6,7 @@
The category the app lives in
-Signature:
+**Signature:**
```typescript
readonly category?: AppCategory;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md
index 2b4d22be187f9..06c920b1b5aa1 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md
@@ -6,7 +6,7 @@
Disables a link from being clickable.
-Signature:
+**Signature:**
```typescript
readonly disabled?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md
index e30e8262f40b2..c2f94a6125f0b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md
@@ -6,7 +6,7 @@
A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property.
-Signature:
+**Signature:**
```typescript
readonly euiIconType?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md
index 8f8be18fa7bfa..fd87b63a3daea 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md
@@ -6,7 +6,7 @@
Hides a link from the navigation.
-Signature:
+**Signature:**
```typescript
readonly hidden?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md
index f51fa7e5b1355..da648d96423f0 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md
@@ -6,7 +6,7 @@
Settled state between `url`, `baseUrl`, and `active`
-Signature:
+**Signature:**
```typescript
readonly href: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md
index dbc922b2a9547..65c90a7ca00cb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md
@@ -6,7 +6,7 @@
A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
-Signature:
+**Signature:**
```typescript
readonly icon?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md
index a07f7963539ec..5049c0e5c23c5 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md
@@ -6,7 +6,7 @@
A unique identifier for looking up links.
-Signature:
+**Signature:**
```typescript
readonly id: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md
index 964f4d4b86aaa..967aed3c38b6c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md
@@ -5,7 +5,7 @@
## ChromeNavLink interface
-Signature:
+**Signature:**
```typescript
export interface ChromeNavLink
@@ -13,18 +13,18 @@ export interface ChromeNavLink
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | string | The base route used to open the root of an application. |
-| [category?](./kibana-plugin-core-public.chromenavlink.category.md) | AppCategory | (Optional) The category the app lives in |
-| [disabled?](./kibana-plugin-core-public.chromenavlink.disabled.md) | boolean | (Optional) Disables a link from being clickable. |
-| [euiIconType?](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | string | (Optional) A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. |
-| [hidden?](./kibana-plugin-core-public.chromenavlink.hidden.md) | boolean | (Optional) Hides a link from the navigation. |
-| [href](./kibana-plugin-core-public.chromenavlink.href.md) | string | Settled state between url, baseUrl, and active |
-| [icon?](./kibana-plugin-core-public.chromenavlink.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. |
-| [id](./kibana-plugin-core-public.chromenavlink.id.md) | string | A unique identifier for looking up links. |
-| [order?](./kibana-plugin-core-public.chromenavlink.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. |
-| [title](./kibana-plugin-core-public.chromenavlink.title.md) | string | The title of the application. |
-| [tooltip?](./kibana-plugin-core-public.chromenavlink.tooltip.md) | string | (Optional) A tooltip shown when hovering over an app link. |
-| [url](./kibana-plugin-core-public.chromenavlink.url.md) | string | The route used to open the default path and the deep links of an application. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | readonly | string | The base route used to open the root of an application. |
+| [category?](./kibana-plugin-core-public.chromenavlink.category.md) | readonly | AppCategory | _(Optional)_ The category the app lives in |
+| [disabled?](./kibana-plugin-core-public.chromenavlink.disabled.md) | readonly | boolean | _(Optional)_ Disables a link from being clickable. |
+| [euiIconType?](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | readonly | string | _(Optional)_ A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. |
+| [hidden?](./kibana-plugin-core-public.chromenavlink.hidden.md) | readonly | boolean | _(Optional)_ Hides a link from the navigation. |
+| [href](./kibana-plugin-core-public.chromenavlink.href.md) | readonly | string | Settled state between url, baseUrl, and active |
+| [icon?](./kibana-plugin-core-public.chromenavlink.icon.md) | readonly | string | _(Optional)_ A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. |
+| [id](./kibana-plugin-core-public.chromenavlink.id.md) | readonly | string | A unique identifier for looking up links. |
+| [order?](./kibana-plugin-core-public.chromenavlink.order.md) | readonly | number | _(Optional)_ An ordinal used to sort nav links relative to one another for display. |
+| [title](./kibana-plugin-core-public.chromenavlink.title.md) | readonly | string | The title of the application. |
+| [tooltip?](./kibana-plugin-core-public.chromenavlink.tooltip.md) | readonly | string | _(Optional)_ A tooltip shown when hovering over an app link. |
+| [url](./kibana-plugin-core-public.chromenavlink.url.md) | readonly | string | The route used to open the default path and the deep links of an application. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md
index 3597a619a8b20..b6ed59bbd179f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md
@@ -6,7 +6,7 @@
An ordinal used to sort nav links relative to one another for display.
-Signature:
+**Signature:**
```typescript
readonly order?: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md
index 43b1a08755aaf..a835e3cb2df8f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md
@@ -6,7 +6,7 @@
The title of the application.
-Signature:
+**Signature:**
```typescript
readonly title: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md
index 551667dbbb35e..b8744b4740cda 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md
@@ -6,7 +6,7 @@
A tooltip shown when hovering over an app link.
-Signature:
+**Signature:**
```typescript
readonly tooltip?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md
index b9d12e450df50..bf4e8d464bfce 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md
@@ -6,7 +6,7 @@
The route used to open the default path and the deep links of an application.
-Signature:
+**Signature:**
```typescript
readonly url: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md
index 4f9b6aaada5db..7231a97db2920 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md
@@ -6,12 +6,12 @@
Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated.
-Signature:
+**Signature:**
```typescript
enableForcedAppSwitcherNavigation(): void;
```
-Returns:
+**Returns:**
void
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md
index 796d99b9b0e0c..e615d7d4930ef 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md
@@ -6,7 +6,7 @@
Get the state of a navlink at this point in time.
-Signature:
+**Signature:**
```typescript
get(id: string): ChromeNavLink | undefined;
@@ -18,7 +18,7 @@ get(id: string): ChromeNavLink | undefined;
| --- | --- | --- |
| id | string | |
-Returns:
+**Returns:**
ChromeNavLink \| undefined
diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md
index 08d5707fe3251..fae69bd6332de 100644
--- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md
+++ b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md
@@ -6,12 +6,12 @@
Get the current state of all navlinks.
-Signature:
+**Signature:**
```typescript
getAll(): Arrayreadonly | string | |
+| [ELASTIC\_WEBSITE\_URL](./kibana-plugin-core-public.doclinksstart.elastic_website_url.md) | readonly | string | |
+| [links](./kibana-plugin-core-public.doclinksstart.links.md) | readonly | { readonly settings: string; readonly elasticStackGetStarted: string; readonly upgrade: { readonly upgradingStackOnPrem: string; readonly upgradingStackOnCloud: string; }; readonly apm: { readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; }; readonly canvas: { readonly guide: string; }; readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record<string, string>; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; readonly suricataModule: string; readonly zeekModule: string; }; readonly auditbeat: { readonly base: string; readonly auditdModule: string; readonly systemModule: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly libbeat: { readonly getStarted: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite\_missing\_bucket: string; readonly date\_histogram: string; readonly date\_range: string; readonly date\_format\_pattern: string; readonly filter: string; readonly filters: string; readonly geohash\_grid: string; readonly histogram: string; readonly ip\_range: string; readonly range: string; readonly significant\_terms: string; readonly terms: string; readonly avg: string; readonly avg\_bucket: string; readonly max\_bucket: string; readonly min\_bucket: string; readonly sum\_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative\_sum: string; readonly derivative: string; readonly geo\_bounds: string; readonly geo\_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving\_avg: string; readonly percentile\_ranks: string; readonly serial\_diff: string; readonly std\_dev: string; readonly sum: string; readonly top\_hits: string; }; readonly runtimeFields: { readonly overview: string; readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly search: { readonly sessions: string; readonly sessionLimits: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; readonly runtimeFields: string; }; readonly addData: string; readonly kibana: string; readonly upgradeAssistant: { readonly overview: string; readonly batchReindex: string; readonly remoteReindex: string; }; readonly rollupJobs: string; readonly elasticsearch: Record<string, string>; readonly siem: { readonly privileges: string; readonly guide: string; readonly gettingStarted: string; readonly ml: string; readonly ruleChangeLog: string; readonly detectionsReq: string; readonly networkMap: string; readonly troubleshootGaps: string; }; readonly securitySolution: { readonly trustedApps: string; }; readonly query: { readonly eql: string; readonly kueryQuerySyntax: string; readonly luceneQuerySyntax: string; readonly percolate: string; readonly queryDsl: string; readonly autocompleteChanges: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record<string, string>; readonly ml: Record<string, string>; readonly transforms: Record<string, string>; readonly visualize: Record<string, string>; readonly apis: Readonly<{ bulkIndexAlias: string; byteSizeUnits: string; createAutoFollowPattern: string; createFollower: string; createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createRollupJobsRequest: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putIndexTemplateV1: string; putWatch: string; simulatePipeline: string; timeUnits: string; updateTransform: string; }>; readonly observability: Readonly<{ guide: string; infrastructureThreshold: string; logsThreshold: string; metricsThreshold: string; monitorStatus: string; monitorUptime: string; tlsCertificate: string; uptimeDurationAnomaly: string; }>; readonly alerting: Record<string, string>; readonly maps: Record<string, string>; readonly monitoring: Record<string, string>; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; elasticsearchEnableApiKeys: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly spaces: Readonly<{ kibanaLegacyUrlAliases: string; kibanaDisableLegacyUrlAliasesApi: string; }>; readonly watcher: Record<string, string>; readonly ccs: Record<string, string>; readonly plugins: { azureRepo: string; gcsRepo: string; hdfsRepo: string; s3Repo: string; snapshotRestoreRepos: string; mapperSize: string; }; readonly snapshotRestore: Record<string, string>; readonly ingest: Record<string, string>; readonly fleet: Readonly<{ beatsAgentComparison: string; guide: string; fleetServer: string; fleetServerAddFleetServer: string; settings: string; settingsFleetServerHostSettings: string; settingsFleetServerProxySettings: string; troubleshooting: string; elasticAgent: string; datastreams: string; datastreamsNamingScheme: string; installElasticAgent: string; upgradeElasticAgent: string; upgradeElasticAgent712lower: string; learnMoreBlog: string; apiKeysLearnMore: string; onPremRegistry: string; }>; readonly ecs: { readonly guide: string; }; readonly clients: { readonly guide: string; readonly goOverview: string; readonly javaIndex: string; readonly jsIntro: string; readonly netGuide: string; readonly perlGuide: string; readonly phpGuide: string; readonly pythonGuide: string; readonly rubyOverview: string; readonly rustGuide: string; }; readonly endpoints: { readonly troubleshooting: string; }; } | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md
index c2bddc58d9c3b..34b9d224f2ee6 100644
--- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md
@@ -6,17 +6,17 @@
Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs.
-Signature:
+**Signature:**
```typescript
export interface ErrorToastOptions extends ToastOptions
```
-Extends: ToastOptions
+**Extends:** ToastOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | string | The title of the toast and the dialog when expanding the message. |
-| [toastMessage?](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | string | (Optional) The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | | string | The title of the toast and the dialog when expanding the message. |
+| [toastMessage?](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | | string | _(Optional)_ The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md
index bad316896cf5c..61680b2154dc4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md
+++ b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md
@@ -6,7 +6,7 @@
The title of the toast and the dialog when expanding the message.
-Signature:
+**Signature:**
```typescript
title: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md
index a96143a94b211..709fcdc012229 100644
--- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md
+++ b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md
@@ -6,7 +6,7 @@
The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal.
-Signature:
+**Signature:**
```typescript
toastMessage?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md
index 9b2803e4f12ea..64ad35575318c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md
@@ -6,7 +6,7 @@
Represents the `message` and `stack` of a fatal Error
-Signature:
+**Signature:**
```typescript
export interface FatalErrorInfo
@@ -14,8 +14,8 @@ export interface FatalErrorInfo
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | string | |
-| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | string \| undefined | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | | string | |
+| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | | string \| undefined | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md
index c623f7e6bf910..a74bae35bf058 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md
@@ -4,7 +4,7 @@
## FatalErrorInfo.message property
-Signature:
+**Signature:**
```typescript
message: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md
index 5f8052be6a77a..71c6d6105ad06 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md
@@ -4,7 +4,7 @@
## FatalErrorInfo.stack property
-Signature:
+**Signature:**
```typescript
stack: string | undefined;
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md
index 0b2a064a4c7df..9f79320493e43 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md
@@ -6,7 +6,7 @@
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.
-Signature:
+**Signature:**
```typescript
add: (error: string | Error, source?: string) => never;
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md
index 15bf94d5b7cd6..959e2e738c349 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md
@@ -6,7 +6,7 @@
An Observable that will emit whenever a fatal error is added with `add()`
-Signature:
+**Signature:**
```typescript
get$: () => Rx.Observableadd() |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) | | (error: string \| Error, source?: string) => never | 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-core-public.fatalerrorssetup.get_.md) | | () => Rx.Observable<FatalErrorInfo> | An Observable that will emit whenever a fatal error is added with add() |
diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md
index dd462eb435369..fe1e94dfe42de 100644
--- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md
+++ b/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md
@@ -6,7 +6,7 @@
FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error.
-Signature:
+**Signature:**
```typescript
export declare type FatalErrorsStart = FatalErrorsSetup;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md
index 264e00a73fd2f..28da74261d0f3 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md
@@ -6,7 +6,7 @@
When `true` the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When `false`, the return type will just be the parsed response body. Defaults to `false`.
-Signature:
+**Signature:**
```typescript
asResponse?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md
index f74a9d02f8420..f4e041c73cfb8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md
@@ -6,7 +6,7 @@
Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to `false`.
-Signature:
+**Signature:**
```typescript
asSystemRequest?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md
index 09ab95a5135f6..53e669697cdc4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md
@@ -4,7 +4,7 @@
## HttpFetchOptions.context property
-Signature:
+**Signature:**
```typescript
context?: KibanaExecutionContext;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md
index b29725b727cdb..f70458da64514 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md
@@ -6,7 +6,7 @@
Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md).
-Signature:
+**Signature:**
```typescript
headers?: HttpHeadersInit;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md
index 9a7f05ab9cd3e..32a71f259c324 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md
@@ -6,21 +6,21 @@
All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md).
-Signature:
+**Signature:**
```typescript
export interface HttpFetchOptions extends HttpRequestInit
```
-Extends: HttpRequestInit
+**Extends:** HttpRequestInit
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [asResponse?](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | boolean | (Optional) When true the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When false, the return type will just be the parsed response body. Defaults to false. |
-| [asSystemRequest?](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | boolean | (Optional) Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to false. |
-| [context?](./kibana-plugin-core-public.httpfetchoptions.context.md) | KibanaExecutionContext | (Optional) |
-| [headers?](./kibana-plugin-core-public.httpfetchoptions.headers.md) | HttpHeadersInit | (Optional) Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). |
-| [prependBasePath?](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | boolean | (Optional) Whether or not the request should automatically prepend the basePath. Defaults to true. |
-| [query?](./kibana-plugin-core-public.httpfetchoptions.query.md) | HttpFetchQuery | (Optional) The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [asResponse?](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | | boolean | _(Optional)_ When true the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When false, the return type will just be the parsed response body. Defaults to false. |
+| [asSystemRequest?](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | | boolean | _(Optional)_ Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to false. |
+| [context?](./kibana-plugin-core-public.httpfetchoptions.context.md) | | KibanaExecutionContext | _(Optional)_ |
+| [headers?](./kibana-plugin-core-public.httpfetchoptions.headers.md) | | HttpHeadersInit | _(Optional)_ Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). |
+| [prependBasePath?](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | | boolean | _(Optional)_ Whether or not the request should automatically prepend the basePath. Defaults to true. |
+| [query?](./kibana-plugin-core-public.httpfetchoptions.query.md) | | HttpFetchQuery | _(Optional)_ The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). |
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md
index ca638d472c52f..f098d8a06d558 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md
@@ -6,7 +6,7 @@
Whether or not the request should automatically prepend the basePath. Defaults to `true`.
-Signature:
+**Signature:**
```typescript
prependBasePath?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md
index b03e48aa15cc5..42947b8508922 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md
@@ -6,7 +6,7 @@
The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md).
-Signature:
+**Signature:**
```typescript
query?: HttpFetchQuery;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md
index 78155adaf627e..e66aecdd939d8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md
@@ -6,16 +6,16 @@
Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included.
-Signature:
+**Signature:**
```typescript
export interface HttpFetchOptionsWithPath extends HttpFetchOptions
```
-Extends: HttpFetchOptions
+**Extends:** HttpFetchOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | string | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | | string | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md
index b360d7d1fb824..dcff5c9afdccb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md
@@ -4,7 +4,7 @@
## HttpFetchOptionsWithPath.path property
-Signature:
+**Signature:**
```typescript
path: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md
index 29627ddd122fe..1db0cb8001573 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md
@@ -5,7 +5,7 @@
## HttpFetchQuery interface
-Signature:
+**Signature:**
```typescript
export interface HttpFetchQuery
diff --git a/docs/development/core/public/kibana-plugin-core-public.httphandler.md b/docs/development/core/public/kibana-plugin-core-public.httphandler.md
index 6a119b186bfa1..42bc5966364cf 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httphandler.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httphandler.md
@@ -6,7 +6,7 @@
A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-core-public.httpresponse.md) for the response.
-Signature:
+**Signature:**
```typescript
export interface HttpHandler
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md b/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md
index e05303a23afc8..6d0fa8beb882f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md
@@ -6,7 +6,7 @@
Headers to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause [HttpHandler](./kibana-plugin-core-public.httphandler.md) to throw an error.
-Signature:
+**Signature:**
```typescript
export interface HttpHeadersInit
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md
index e1843b1a52988..e34e2c8472fa4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md
@@ -6,7 +6,7 @@
An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md).
-Signature:
+**Signature:**
```typescript
export interface HttpInterceptor
@@ -16,8 +16,8 @@ export interface HttpInterceptor
| Method | Description |
| --- | --- |
-| [request(fetchOptions, controller)?](./kibana-plugin-core-public.httpinterceptor.request.md) | (Optional) Define an interceptor to be executed before a request is sent. |
-| [requestError(httpErrorRequest, controller)?](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | (Optional) Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. |
-| [response(httpResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.response.md) | (Optional) Define an interceptor to be executed after a response is received. |
-| [responseError(httpErrorResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | (Optional) Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |
+| [request(fetchOptions, controller)?](./kibana-plugin-core-public.httpinterceptor.request.md) | _(Optional)_ Define an interceptor to be executed before a request is sent. |
+| [requestError(httpErrorRequest, controller)?](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | _(Optional)_ Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. |
+| [response(httpResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.response.md) | _(Optional)_ Define an interceptor to be executed after a response is received. |
+| [responseError(httpErrorResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | _(Optional)_ Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md
index 95181e6d509f1..a24c25cd1068f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md
@@ -6,7 +6,7 @@
Define an interceptor to be executed before a request is sent.
-Signature:
+**Signature:**
```typescript
request?(fetchOptions: ReadonlyReferer header of the request being made. |
-| [referrerPolicy?](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | ReferrerPolicy | (Optional) The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. |
-| [signal?](./kibana-plugin-core-public.httprequestinit.signal.md) | AbortSignal \| null | (Optional) Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. |
-| [window?](./kibana-plugin-core-public.httprequestinit.window.md) | null | (Optional) Can only be null. Used to disassociate request from any Window. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [body?](./kibana-plugin-core-public.httprequestinit.body.md) | | BodyInit \| null | _(Optional)_ A BodyInit object or null to set request's body. |
+| [cache?](./kibana-plugin-core-public.httprequestinit.cache.md) | | RequestCache | _(Optional)_ The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. |
+| [credentials?](./kibana-plugin-core-public.httprequestinit.credentials.md) | | RequestCredentials | _(Optional)_ The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. |
+| [headers?](./kibana-plugin-core-public.httprequestinit.headers.md) | | HttpHeadersInit | _(Optional)_ [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) |
+| [integrity?](./kibana-plugin-core-public.httprequestinit.integrity.md) | | string | _(Optional)_ Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. |
+| [keepalive?](./kibana-plugin-core-public.httprequestinit.keepalive.md) | | boolean | _(Optional)_ Whether or not request can outlive the global in which it was created. |
+| [method?](./kibana-plugin-core-public.httprequestinit.method.md) | | string | _(Optional)_ HTTP method, which is "GET" by default. |
+| [mode?](./kibana-plugin-core-public.httprequestinit.mode.md) | | RequestMode | _(Optional)_ The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. |
+| [redirect?](./kibana-plugin-core-public.httprequestinit.redirect.md) | | RequestRedirect | _(Optional)_ The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. |
+| [referrer?](./kibana-plugin-core-public.httprequestinit.referrer.md) | | string | _(Optional)_ The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made. |
+| [referrerPolicy?](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | | ReferrerPolicy | _(Optional)_ The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. |
+| [signal?](./kibana-plugin-core-public.httprequestinit.signal.md) | | AbortSignal \| null | _(Optional)_ Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. |
+| [window?](./kibana-plugin-core-public.httprequestinit.window.md) | | null | _(Optional)_ Can only be null. Used to disassociate request from any Window. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md
index f650c32f70701..17bb5e1f003d3 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md
@@ -6,7 +6,7 @@
HTTP method, which is "GET" by default.
-Signature:
+**Signature:**
```typescript
method?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md
index 4617b02c67420..f346cfd99b05b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md
@@ -6,7 +6,7 @@
The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.
-Signature:
+**Signature:**
```typescript
mode?: RequestMode;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md
index f1ae55f77f133..890ca11276be3 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md
@@ -6,7 +6,7 @@
The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.
-Signature:
+**Signature:**
```typescript
redirect?: RequestRedirect;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md
index 19c0435742a91..a4debb1c10a7f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md
@@ -6,7 +6,7 @@
The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made.
-Signature:
+**Signature:**
```typescript
referrer?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md
index 30fc275ebf6bd..b7b41feda7686 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md
@@ -6,7 +6,7 @@
The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.
-Signature:
+**Signature:**
```typescript
referrerPolicy?: ReferrerPolicy;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md
index 8f309e7b877dc..b0a0304d5c713 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md
@@ -6,7 +6,7 @@
Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.
-Signature:
+**Signature:**
```typescript
signal?: AbortSignal | null;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md
index 6bafc9a03da58..c08b135310f25 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md
@@ -6,7 +6,7 @@
Can only be null. Used to disassociate request from any Window.
-Signature:
+**Signature:**
```typescript
window?: null;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md
index 5d2cb693f63e0..e713cf48b2280 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md
@@ -6,7 +6,7 @@
Parsed body received, may be undefined if there was an error.
-Signature:
+**Signature:**
```typescript
readonly body?: TResponseBody;
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md
index 19e74f0da9fba..edb869bc238ac 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md
@@ -6,7 +6,7 @@
The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request.
-Signature:
+**Signature:**
```typescript
readonly fetchOptions: Readonlyreadonly | TResponseBody | _(Optional)_ Parsed body received, may be undefined if there was an error. |
+| [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) | readonly | Readonly<HttpFetchOptionsWithPath> | The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. |
+| [request](./kibana-plugin-core-public.httpresponse.request.md) | readonly | Readonly<Request> | Raw request sent to Kibana server. |
+| [response?](./kibana-plugin-core-public.httpresponse.response.md) | readonly | Readonly<Response> | _(Optional)_ Raw response received, may be undefined if there was an error. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md
index c21b0035835ba..e7c43e59db8cb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md
+++ b/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md
@@ -6,7 +6,7 @@
Raw request sent to Kibana server.
-Signature:
+**Signature:**
```typescript
readonly request: ReadonlybasePath string. |
-| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | (url: string) => string | Prepends path with the basePath. |
-| [publicBaseUrl?](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). |
-| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | (url: string) => string | Removes the prepended basePath from the path. |
-| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | string | Returns the server's root basePath as configured, without any namespace prefix.See for getting the basePath value for a specific request |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [get](./kibana-plugin-core-public.ibasepath.get.md) | | () => string | Gets the basePath string. |
+| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | | (url: string) => string | Prepends path with the basePath. |
+| [publicBaseUrl?](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | readonly | string | _(Optional)_ The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). |
+| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | | (url: string) => string | Removes the prepended basePath from the path. |
+| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | readonly | string | Returns the server's root basePath as configured, without any namespace prefix.
See for getting the basePath value for a specific request
| diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md index b3e55351d350f..4f090770dea8d 100644 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md +++ b/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md @@ -6,7 +6,7 @@ Prepends `path` with the basePath. -Signature: +**Signature:** ```typescript prepend: (url: string) => string; diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md index f45cc6eba2959..b9de10abd5115 100644 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md +++ b/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md @@ -6,7 +6,7 @@ The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). -Signature: +**Signature:** ```typescript readonly publicBaseUrl?: string; diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md index 2fcbe487e95b3..7bda78a844587 100644 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md +++ b/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md @@ -6,7 +6,7 @@ Removes the prepended basePath from the `path`. -Signature: +**Signature:** ```typescript remove: (url: string) => string; diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md index f800b792e7b7f..873b051ae2536 100644 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md +++ b/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md @@ -8,7 +8,7 @@ Returns the server's root basePath as configured, without any namespace prefix. See for getting the basePath value for a specific request -Signature: +**Signature:** ```typescript readonly serverBasePath: string; diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md index 5a598281c7be7..09c32f68cd6f6 100644 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md +++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md @@ -6,7 +6,7 @@ APIs for working with external URLs. -Signature: +**Signature:** ```typescript export interface IExternalUrl @@ -16,5 +16,5 @@ export interface IExternalUrl | Method | Description | | --- | --- | -| [validateUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.validateurl.md) | Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml.If the URL is valid, then a URL will be returned. Otherwise, this will return null. | +| [validateUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.validateurl.md) |Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml.
If the URL is valid, then a URL will be returned. Otherwise, this will return null.
| diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md index 24140effc45d9..01cfd49aebca3 100644 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md +++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md @@ -8,7 +8,7 @@ Determines if the provided URL is a valid location to send users. Validation is If the URL is valid, then a URL will be returned. Otherwise, this will return null. -Signature: +**Signature:** ```typescript validateUrl(relativeOrAbsoluteUrl: string): URL | null; @@ -20,7 +20,7 @@ validateUrl(relativeOrAbsoluteUrl: string): URL | null; | --- | --- | --- | | relativeOrAbsoluteUrl | string | | -Returns: +**Returns:** URL \| null diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md index ec7129a43b99a..a91e1d7ee2fde 100644 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md +++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md @@ -6,7 +6,7 @@ Indicates if this policy allows or denies access to the described destination. -Signature: +**Signature:** ```typescript allow: boolean; diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md index 1d3c9fc9bbaf1..431ef6c9f7533 100644 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md +++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md @@ -6,7 +6,7 @@ Optional host describing the external destination. May be combined with `protocol`. -Signature: +**Signature:** ```typescript host?: string; diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md index 6623fec18d976..5d0b1544d3065 100644 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md +++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md @@ -6,7 +6,7 @@ A policy describing whether access to an external destination is allowed. -Signature: +**Signature:** ```typescript export interface IExternalUrlPolicy @@ -14,9 +14,9 @@ export interface IExternalUrlPolicy ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. | -| [host?](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined withprotocol. |
-| [protocol?](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | | boolean | Indicates if this policy allows or denies access to the described destination. |
+| [host?](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | | string | _(Optional)_ Optional host describing the external destination. May be combined with protocol. |
+| [protocol?](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | | string | _(Optional)_ Optional protocol describing the external destination. May be combined with host. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md
index 6b6f8b9638bb8..26e801488236f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md
+++ b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md
@@ -6,7 +6,7 @@
Optional protocol describing the external destination. May be combined with `host`.
-Signature:
+**Signature:**
```typescript
protocol?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md
index 2a5b5067e0301..805e75fedc27b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md
@@ -4,7 +4,7 @@
## IHttpFetchError.body property
-Signature:
+**Signature:**
```typescript
readonly body?: any;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md
index d7145f9cc4ab7..aae6e2edbe9a4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md
@@ -5,21 +5,21 @@
## IHttpFetchError interface
-Signature:
+**Signature:**
```typescript
export interface IHttpFetchError extends Error
```
-Extends: Error
+**Extends:** Error
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [body?](./kibana-plugin-core-public.ihttpfetcherror.body.md) | any | (Optional) |
-| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | string | |
-| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | Request | |
-| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | Request | |
-| [res?](./kibana-plugin-core-public.ihttpfetcherror.res.md) | Response | (Optional) |
-| [response?](./kibana-plugin-core-public.ihttpfetcherror.response.md) | Response | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [body?](./kibana-plugin-core-public.ihttpfetcherror.body.md) | readonly | any | _(Optional)_ |
+| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | readonly | string | |
+| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | readonly | Request | |
+| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | readonly | Request | |
+| [res?](./kibana-plugin-core-public.ihttpfetcherror.res.md) | readonly | Response | _(Optional)_ |
+| [response?](./kibana-plugin-core-public.ihttpfetcherror.response.md) | readonly | Response | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md
index 4ab1ddd4b90ac..58e0ca1fa6055 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md
@@ -4,7 +4,7 @@
## IHttpFetchError.name property
-Signature:
+**Signature:**
```typescript
readonly name: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md
index fb5b66cc15e71..8f912c81bd80a 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md
@@ -9,7 +9,7 @@
> Provided for legacy compatibility. Prefer the `request` property instead.
>
-Signature:
+**Signature:**
```typescript
readonly req: Request;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md
index 193d4cf92587e..ad01997d591d4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md
@@ -4,7 +4,7 @@
## IHttpFetchError.request property
-Signature:
+**Signature:**
```typescript
readonly request: Request;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md
index d07f65dc5acea..275d2d9d9991d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md
@@ -9,7 +9,7 @@
> Provided for legacy compatibility. Prefer the `response` property instead.
>
-Signature:
+**Signature:**
```typescript
readonly res?: Response;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md
index 1f7fcc746e19b..210e7a4b591cd 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md
@@ -4,7 +4,7 @@
## IHttpFetchError.response property
-Signature:
+**Signature:**
```typescript
readonly response?: Response;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md
index b982e4dbac8a6..2bfdde729f586 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md
@@ -6,12 +6,12 @@
Halt the request Promise chain and do not process further interceptors or response handlers.
-Signature:
+**Signature:**
```typescript
halt(): void;
```
-Returns:
+**Returns:**
void
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md
index 82e5378412a5a..671eb5026d416 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md
@@ -6,7 +6,7 @@
Whether or not this chain has been halted.
-Signature:
+**Signature:**
```typescript
halted: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md
index 15a66ef569e7d..b135eebe75e15 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md
@@ -6,7 +6,7 @@
Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md).
-Signature:
+**Signature:**
```typescript
export interface IHttpInterceptController
@@ -14,9 +14,9 @@ export interface IHttpInterceptController
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | boolean | Whether or not this chain has been halted. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | | boolean | Whether or not this chain has been halted. |
## Methods
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md
index 70dfe72d62ac5..38f202b5b1b8b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md
@@ -6,7 +6,7 @@
Parsed body received, may be undefined if there was an error.
-Signature:
+**Signature:**
```typescript
readonly body?: TResponseBody;
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md
index 6022e07c356e3..1b6552e2158dc 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md
@@ -6,7 +6,7 @@
Properties that can be returned by HttpInterceptor.request to override the response.
-Signature:
+**Signature:**
```typescript
export interface IHttpResponseInterceptorOverridesreadonly | TResponseBody | _(Optional)_ Parsed body received, may be undefined if there was an error. |
+| [response?](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md) | readonly | Readonly<Response> | _(Optional)_ Raw response received, may be undefined if there was an error. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md
index c858200c2113f..0c444eb2a5952 100644
--- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md
+++ b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md
@@ -6,7 +6,7 @@
Raw response received, may be undefined if there was an error.
-Signature:
+**Signature:**
```typescript
readonly response?: ReadonlydefaultOverride parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. |
-| [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) | <T = any>(key: string, defaultOverride?: T) => Observable<T> | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a defaultOverride argument behaves the same as it does in \#get() |
-| [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) | () => Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>> | Gets the metadata about all uiSettings, including the type, default value, and user value for each key. |
-| [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) | <T = any>() => Observable<{ key: string; newValue: T; oldValue: T; }> | 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-core-public.iuisettingsclient.getupdateerrors_.md) | () => Observable<Error> | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. |
-| [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) | (key: string) => boolean | Returns true if the setting wasn't registered by any plugin, but was either added directly via set(), or is an unknown setting found in the uiSettings saved object |
-| [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) | (key: string) => boolean | Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the set() method. |
-| [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) | (key: string) => boolean | Returns true if the setting has no user-defined value or is unknown |
-| [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. |
-| [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) | (key: string) => Promise<boolean> | Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling set(key, null), including the synchronization, custom setting, and error behavior of that method. |
-| [set](./kibana-plugin-core-public.iuisettingsclient.set.md) | (key: string, value: any) => Promise<boolean> | Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the get() method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before set() was called. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [get](./kibana-plugin-core-public.iuisettingsclient.get.md) | | <T = any>(key: string, defaultOverride?: T) => T | Gets the value for a specific uiSetting. If this setting has no user-defined value then the defaultOverride parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. |
+| [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) | | <T = any>(key: string, defaultOverride?: T) => Observable<T> | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a defaultOverride argument behaves the same as it does in \#get() |
+| [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) | | () => Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>> | Gets the metadata about all uiSettings, including the type, default value, and user value for each key. |
+| [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) | | <T = any>() => Observable<{ key: string; newValue: T; oldValue: T; }> | 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-core-public.iuisettingsclient.getupdateerrors_.md) | | () => Observable<Error> | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. |
+| [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) | | (key: string) => boolean | Returns true if the setting wasn't registered by any plugin, but was either added directly via set(), or is an unknown setting found in the uiSettings saved object |
+| [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) | | (key: string) => boolean | Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the set() method. |
+| [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) | | (key: string) => boolean | Returns true if the setting has no user-defined value or is unknown |
+| [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) | | (key: string) => boolean | Shows whether the uiSettings value set by the user. |
+| [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) | | (key: string) => Promise<boolean> | Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling set(key, null), including the synchronization, custom setting, and error behavior of that method. |
+| [set](./kibana-plugin-core-public.iuisettingsclient.set.md) | | (key: string, value: any) => Promise<boolean> | Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the get() method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before set() was called. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md
index b6d4ff04cf4a1..2d846d5432d7e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md
+++ b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md
@@ -6,7 +6,7 @@
Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling `set(key, null)`, including the synchronization, custom setting, and error behavior of that method.
-Signature:
+**Signature:**
```typescript
remove: (key: string) => PromiseHistory instance that is scoped to a particular base path of the history stack. Behaves similarly to the basename option except that this wrapper hides any history stack entries from outside the scope of this base path.This wrapper also allows Core and Plugins to share a single underlying global History instance without exposing the history of other applications.The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. |
-| [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md).It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. |
+| [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) | A wrapper around a History instance that is scoped to a particular base path of the history stack. Behaves similarly to the basename option except that this wrapper hides any history stack entries from outside the scope of this base path.
This wrapper also allows Core and Plugins to share a single underlying global History instance without exposing the history of other applications.
The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath.
| +| [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) |This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md).
It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations.
| | [ToastsApi](./kibana-plugin-core-public.toastsapi.md) | Methods for adding and removing global toast messages. | ## Enumerations @@ -33,8 +33,8 @@ The plugin integrates with the core system via lifecycle events: `setup` | --- | --- | | [App](./kibana-plugin-core-public.app.md) | | | [AppCategory](./kibana-plugin-core-public.appcategory.md) | A category definition for nav links to know where to sort them in the left hand nav | -| [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application.See | -| [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application.See | +| [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) |Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application.
See
| +| [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) |Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application.
See
| | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | | | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | | | [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) | | @@ -114,8 +114,8 @@ The plugin integrates with the core system via lifecycle events: `setup` | [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) | | | [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) | | | [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) | | -| [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objectsfind() method.\*Note\*: this type is different between the Public and Server Saved Objects clients. |
-| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) | A warning meant to notify that a specific user action is required to finalize the import of some type of object. The actionUrl must be a path relative to the basePath, and not include it. |
+| [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects find() method.
\*Note\*: this type is different between the Public and Server Saved Objects clients.
| +| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) |A warning meant to notify that a specific user action is required to finalize the import of some type of object.
The actionUrl must be a path relative to the basePath, and not include it.
path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
-| [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) | Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) |
-| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) | A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return confirm to prompt a message to the user before leaving the page, or default to keep the default behavior (doing nothing).See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. |
+| [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) | Input type for registering secondary in-app locations for an application.
Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)
See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md)
| +| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) |A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return confirm to prompt a message to the user before leaving the page, or default to keep the default behavior (doing nothing).
See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples.
| | [AppMount](./kibana-plugin-core-public.appmount.md) | A mount function called when the user navigates to this app's route. | | [AppUnmount](./kibana-plugin-core-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. | | [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) | Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md). | @@ -171,7 +171,7 @@ The plugin integrates with the core system via lifecycle events: `setup` | [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | Type definition for a Saved Object attribute value | | [SavedObjectAttributeSingle](./kibana-plugin-core-public.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | | [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) | SavedObjectsClientContract as implemented by the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md) | -| [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) | Composite type of all the possible types of import warnings.See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details. | +| [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) |Composite type of all the possible types of import warnings.
See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details.
| | [SavedObjectsNamespaceType](./kibana-plugin-core-public.savedobjectsnamespacetype.md) | The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. | | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers, such as [App.mount](./kibana-plugin-core-public.app.mount.md). Promise will not resolve until Core and plugin dependencies have completedstart. |
| [Toast](./kibana-plugin-core-public.toast.md) | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md b/docs/development/core/public/kibana-plugin-core-public.mountpoint.md
index 41c6269b3e6da..af776b2683e2d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md
+++ b/docs/development/core/public/kibana-plugin-core-public.mountpoint.md
@@ -6,7 +6,7 @@
A function that should mount DOM content inside the provided container element and return a handler to unmount it.
-Signature:
+**Signature:**
```typescript
export declare type MountPointreplace instead of push) |
-| [state?](./kibana-plugin-core-public.navigatetoappoptions.state.md) | unknown | (Optional) optional state to forward to the application |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [deepLinkId?](./kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md) | | string | _(Optional)_ optional [deep link](./kibana-plugin-core-public.app.deeplinks.md) id inside the application to navigate to. If an additional [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) is defined it will be appended to the deep link path. |
+| [openInNewTab?](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) | | boolean | _(Optional)_ if true, will open the app in new tab, will share session information via window.open if base |
+| [path?](./kibana-plugin-core-public.navigatetoappoptions.path.md) | | string | _(Optional)_ optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default. |
+| [replace?](./kibana-plugin-core-public.navigatetoappoptions.replace.md) | | boolean | _(Optional)_ if true, will not create a new history entry when navigating (using replace instead of push) |
+| [state?](./kibana-plugin-core-public.navigatetoappoptions.state.md) | | unknown | _(Optional)_ optional state to forward to the application |
diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md
index 4609fa68b3824..1e9681dc8d72e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md
+++ b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md
@@ -6,7 +6,7 @@
if true, will open the app in new tab, will share session information via window.open if base
-Signature:
+**Signature:**
```typescript
openInNewTab?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md
index b39fc8c324ad9..ab6a55104f633 100644
--- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md
+++ b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md
@@ -6,7 +6,7 @@
optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default.
-Signature:
+**Signature:**
```typescript
path?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md
index 8a7440025aedc..8249835a7cd09 100644
--- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md
+++ b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md
@@ -6,7 +6,7 @@
if true, will not create a new history entry when navigating (using `replace` instead of `push`)
-Signature:
+**Signature:**
```typescript
replace?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md
index ccb76f7bbf18e..33ed7d24dd2f7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md
+++ b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md
@@ -6,7 +6,7 @@
optional state to forward to the application
-Signature:
+**Signature:**
```typescript
state?: unknown;
diff --git a/docs/development/core/public/kibana-plugin-core-public.navtype.md b/docs/development/core/public/kibana-plugin-core-public.navtype.md
index 8f1d9a4351754..74a01fa17f214 100644
--- a/docs/development/core/public/kibana-plugin-core-public.navtype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.navtype.md
@@ -4,7 +4,7 @@
## NavType type
-Signature:
+**Signature:**
```typescript
export declare type NavType = 'modern' | 'legacy';
diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md
index efaeafa1afb1a..be8daad1ca866 100644
--- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md
+++ b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md
@@ -5,7 +5,7 @@
## NotificationsSetup interface
-Signature:
+**Signature:**
```typescript
export interface NotificationsSetup
@@ -13,7 +13,7 @@ export interface NotificationsSetup
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) | ToastsSetup | [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) | | ToastsSetup | [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) |
diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md
index f544ce98989b2..bde029c407231 100644
--- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md
+++ b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md
@@ -6,7 +6,7 @@
[ToastsSetup](./kibana-plugin-core-public.toastssetup.md)
-Signature:
+**Signature:**
```typescript
toasts: ToastsSetup;
diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md
index 0e77badd51235..0e0b8cb17294e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md
+++ b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md
@@ -5,7 +5,7 @@
## NotificationsStart interface
-Signature:
+**Signature:**
```typescript
export interface NotificationsStart
@@ -13,7 +13,7 @@ export interface NotificationsStart
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) | ToastsStart | [ToastsStart](./kibana-plugin-core-public.toastsstart.md) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) | | ToastsStart | [ToastsStart](./kibana-plugin-core-public.toastsstart.md) |
diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md
index a047c66f04e71..c0eaf1c1bc408 100644
--- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md
+++ b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md
@@ -6,7 +6,7 @@
[ToastsStart](./kibana-plugin-core-public.toastsstart.md)
-Signature:
+**Signature:**
```typescript
toasts: ToastsStart;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md
index fd3ce0b3a4292..e75467bde9627 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md
@@ -6,7 +6,7 @@
Add a new banner
-Signature:
+**Signature:**
```typescript
add(mount: MountPoint, priority?: number): string;
@@ -17,9 +17,9 @@ add(mount: MountPoint, priority?: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) |
-| priority | number | optional priority order to display this banner. Higher priority values are shown first. |
+| priority | number | _(Optional)_ optional priority order to display this banner. Higher priority values are shown first. |
-Returns:
+**Returns:**
string
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md
index b5f0ab1d01299..8f0e80394b9ba 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md
@@ -4,12 +4,12 @@
## OverlayBannersStart.getComponent() method
-Signature:
+**Signature:**
```typescript
getComponent(): JSX.Element;
```
-Returns:
+**Returns:**
JSX.Element
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md
index f81da84d58bdc..0c0baf2311b51 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md
@@ -5,7 +5,7 @@
## OverlayBannersStart interface
-Signature:
+**Signature:**
```typescript
export interface OverlayBannersStart
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md
index ce1e3ee08bd51..ae1c2227e9edb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md
@@ -6,7 +6,7 @@
Remove a banner
-Signature:
+**Signature:**
```typescript
remove(id: string): boolean;
@@ -18,7 +18,7 @@ remove(id: string): boolean;
| --- | --- | --- |
| id | string | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) |
-Returns:
+**Returns:**
boolean
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md
index ea16c739cc847..6999319f96ddb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md
@@ -6,7 +6,7 @@
Replace a banner in place
-Signature:
+**Signature:**
```typescript
replace(id: string | undefined, mount: MountPoint, priority?: number): string;
@@ -18,9 +18,9 @@ replace(id: string | undefined, mount: MountPoint, priority?: number): string;
| --- | --- | --- |
| id | string \| undefined | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) |
| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) |
-| priority | number | optional priority order to display this banner. Higher priority values are shown first. |
+| priority | number | _(Optional)_ optional priority order to display this banner. Higher priority values are shown first. |
-Returns:
+**Returns:**
string
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md
index f135fa9618958..693e201aba571 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions."aria-label" property
-Signature:
+**Signature:**
```typescript
'aria-label'?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md
index d583aae0e0b19..8f0e88fe96b91 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions."data-test-subj" property
-Signature:
+**Signature:**
```typescript
'data-test-subj'?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md
index 26f6db77cccea..7147aeed0bea6 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.className property
-Signature:
+**Signature:**
```typescript
className?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md
index 44014b7f0d816..830f6a8c70f73 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.closeButtonAriaLabel property
-Signature:
+**Signature:**
```typescript
closeButtonAriaLabel?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md
index 149a53f35d34d..cefa199f56917 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.hideCloseButton property
-Signature:
+**Signature:**
```typescript
hideCloseButton?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md
index 4f582e746191f..fb3a0f24de5ae 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.maxWidth property
-Signature:
+**Signature:**
```typescript
maxWidth?: boolean | number | string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md
index 16ee07930cfa0..d4fa18f44f596 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md
@@ -5,7 +5,7 @@
## OverlayFlyoutOpenOptions interface
-Signature:
+**Signature:**
```typescript
export interface OverlayFlyoutOpenOptions
@@ -13,15 +13,15 @@ export interface OverlayFlyoutOpenOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| ["aria-label"?](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) | string | (Optional) |
-| ["data-test-subj"?](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) | string | (Optional) |
-| [className?](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) | string | (Optional) |
-| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) | string | (Optional) |
-| [hideCloseButton?](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) | boolean | (Optional) |
-| [maxWidth?](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) |
-| [onClose?](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) | (flyout: OverlayRef) => void | (Optional) EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; |
-| [ownFocus?](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) | boolean | (Optional) |
-| [size?](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) | EuiFlyoutSize | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| ["aria-label"?](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) | | string | _(Optional)_ |
+| ["data-test-subj"?](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) | | string | _(Optional)_ |
+| [className?](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) | | string | _(Optional)_ |
+| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) | | string | _(Optional)_ |
+| [hideCloseButton?](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) | | boolean | _(Optional)_ |
+| [maxWidth?](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) | | boolean \| number \| string | _(Optional)_ |
+| [onClose?](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) | | (flyout: OverlayRef) => void | _(Optional)_ EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; |
+| [ownFocus?](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) | | boolean | _(Optional)_ |
+| [size?](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) | | EuiFlyoutSize | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md
index 5cfbba4c84a36..bab5116bb85b8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md
@@ -6,7 +6,7 @@
EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout;
-Signature:
+**Signature:**
```typescript
onClose?: (flyout: OverlayRef) => void;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md
index 337ce2c48e1d9..dccebb49b5ed7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.ownFocus property
-Signature:
+**Signature:**
```typescript
ownFocus?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md
index 3754242dc7c26..5c07837320827 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md
@@ -4,7 +4,7 @@
## OverlayFlyoutOpenOptions.size property
-Signature:
+**Signature:**
```typescript
size?: EuiFlyoutSize;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md
index 790fd57320413..23e63f23d8e44 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md
@@ -6,7 +6,7 @@
APIs to open and manage fly-out dialogs.
-Signature:
+**Signature:**
```typescript
export interface OverlayFlyoutStart
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md
index 94290eb91f942..3f5aec3f100fc 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md
@@ -6,7 +6,7 @@
Opens a flyout panel with the given mount point inside. You can use `close()` on the returned FlyoutRef to close the flyout.
-Signature:
+**Signature:**
```typescript
open(mount: MountPoint, options?: OverlayFlyoutOpenOptions): OverlayRef;
@@ -17,9 +17,9 @@ open(mount: MountPoint, options?: OverlayFlyoutOpenOptions): OverlayRef;
| Parameter | Type | Description |
| --- | --- | --- |
| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside a flyout panel |
-| options | OverlayFlyoutOpenOptions | [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - options for the flyout [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened flyout panel. |
+| options | OverlayFlyoutOpenOptions | _(Optional)_ [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - options for the flyout [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened flyout panel. |
-Returns:
+**Returns:**
OverlayRef
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md
index 3569b2153c3da..04a57d6d1ce4a 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions."data-test-subj" property
-Signature:
+**Signature:**
```typescript
'data-test-subj'?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md
index 5c827e19e42e1..739a485907251 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.buttonColor property
-Signature:
+**Signature:**
```typescript
buttonColor?: EuiConfirmModalProps['buttonColor'];
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md
index 0c0b9fd48dbd6..70fcf37d2a148 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.cancelButtonText property
-Signature:
+**Signature:**
```typescript
cancelButtonText?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md
index 0a622aeaac418..6c2655e2acdd1 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.className property
-Signature:
+**Signature:**
```typescript
className?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md
index 8a321a0b07b4c..d4adf7e3494c6 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.closeButtonAriaLabel property
-Signature:
+**Signature:**
```typescript
closeButtonAriaLabel?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md
index f84d834369f5b..b2d4c2bb7f5c7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.confirmButtonText property
-Signature:
+**Signature:**
```typescript
confirmButtonText?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md
index c5edf48b54ea8..31fdb5b13a499 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.defaultFocusedButton property
-Signature:
+**Signature:**
```typescript
defaultFocusedButton?: EuiConfirmModalProps['defaultFocusedButton'];
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md
index 488b4eb3794fb..b6d2c023c167d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md
@@ -6,7 +6,7 @@
Sets the max-width of the modal. Set to `true` to use the default (`euiBreakpoints 'm'`), set to `false` to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement.
-Signature:
+**Signature:**
```typescript
maxWidth?: boolean | number | string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md
index 2f672e551ba51..221bfe4691b00 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md
@@ -5,7 +5,7 @@
## OverlayModalConfirmOptions interface
-Signature:
+**Signature:**
```typescript
export interface OverlayModalConfirmOptions
@@ -13,15 +13,15 @@ export interface OverlayModalConfirmOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) | string | (Optional) |
-| [buttonColor?](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) | EuiConfirmModalProps\['buttonColor'\] | (Optional) |
-| [cancelButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) | string | (Optional) |
-| [className?](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) | string | (Optional) |
-| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) | string | (Optional) |
-| [confirmButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) | string | (Optional) |
-| [defaultFocusedButton?](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) | EuiConfirmModalProps\['defaultFocusedButton'\] | (Optional) |
-| [maxWidth?](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) | boolean \| number \| string | (Optional) Sets the max-width of the modal. Set to true to use the default (euiBreakpoints 'm'), set to false to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. |
-| [title?](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) | string | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) | | string | _(Optional)_ |
+| [buttonColor?](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) | | EuiConfirmModalProps\['buttonColor'\] | _(Optional)_ |
+| [cancelButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) | | string | _(Optional)_ |
+| [className?](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) | | string | _(Optional)_ |
+| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) | | string | _(Optional)_ |
+| [confirmButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) | | string | _(Optional)_ |
+| [defaultFocusedButton?](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) | | EuiConfirmModalProps\['defaultFocusedButton'\] | _(Optional)_ |
+| [maxWidth?](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) | | boolean \| number \| string | _(Optional)_ Sets the max-width of the modal. Set to true to use the default (euiBreakpoints 'm'), set to false to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. |
+| [title?](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) | | string | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md
index cfbe41e0a7e9f..6caf199ce2693 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md
@@ -4,7 +4,7 @@
## OverlayModalConfirmOptions.title property
-Signature:
+**Signature:**
```typescript
title?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md
index f0eba659dc62b..cc6d099a1c849 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md
@@ -4,7 +4,7 @@
## OverlayModalOpenOptions."data-test-subj" property
-Signature:
+**Signature:**
```typescript
'data-test-subj'?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md
index 769387b8c35ff..eebb2f0d464c8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md
@@ -4,7 +4,7 @@
## OverlayModalOpenOptions.className property
-Signature:
+**Signature:**
```typescript
className?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md
index 4e685055b9e17..0b5b1a61cafc8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md
@@ -4,7 +4,7 @@
## OverlayModalOpenOptions.closeButtonAriaLabel property
-Signature:
+**Signature:**
```typescript
closeButtonAriaLabel?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md
index 0ae888f9cb361..44197743c3e52 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md
@@ -4,7 +4,7 @@
## OverlayModalOpenOptions.maxWidth property
-Signature:
+**Signature:**
```typescript
maxWidth?: boolean | number | string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md
index 5fc978ea26262..8ad24e9f73342 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md
@@ -5,7 +5,7 @@
## OverlayModalOpenOptions interface
-Signature:
+**Signature:**
```typescript
export interface OverlayModalOpenOptions
@@ -13,10 +13,10 @@ export interface OverlayModalOpenOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) | string | (Optional) |
-| [className?](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) | string | (Optional) |
-| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) | string | (Optional) |
-| [maxWidth?](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) | | string | _(Optional)_ |
+| [className?](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) | | string | _(Optional)_ |
+| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) | | string | _(Optional)_ |
+| [maxWidth?](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) | | boolean \| number \| string | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md
index 1d8fe1a92dd90..dfb66f84744df 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md
@@ -6,7 +6,7 @@
APIs to open and manage modal dialogs.
-Signature:
+**Signature:**
```typescript
export interface OverlayModalStart
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md
index 35bfa406b4d17..a41a1de0cc764 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md
@@ -6,7 +6,7 @@
Opens a modal panel with the given mount point inside. You can use `close()` on the returned OverlayRef to close the modal.
-Signature:
+**Signature:**
```typescript
open(mount: MountPoint, options?: OverlayModalOpenOptions): OverlayRef;
@@ -17,9 +17,9 @@ open(mount: MountPoint, options?: OverlayModalOpenOptions): OverlayRef;
| Parameter | Type | Description |
| --- | --- | --- |
| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside the modal |
-| options | OverlayModalOpenOptions | [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - options for the modal [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened modal. |
+| options | OverlayModalOpenOptions | _(Optional)_ [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - options for the modal [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened modal. |
-Returns:
+**Returns:**
OverlayRef
diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md
index 056f512de87bf..3cfb2068b3bb0 100644
--- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md
+++ b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md
@@ -6,7 +6,7 @@
Opens a confirmation modal with the given text or mountpoint as a message. Returns a Promise resolving to `true` if user confirmed or `false` otherwise.
-Signature:
+**Signature:**
```typescript
openConfirm(message: MountPoint | string, options?: OverlayModalConfirmOptions): Promiseclose() on the overlay reference or another overlay replacing yours via openModal or openFlyout. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [onClose](./kibana-plugin-core-public.overlayref.onclose.md) | | Promise<void> | A Promise that will resolve once this overlay is closed.
Overlays can close from user interaction, calling close() on the overlay reference or another overlay replacing yours via openModal or openFlyout.
readonly | { get: <T extends object = ConfigSchema>() => T; } | |
+| [env](./kibana-plugin-core-public.plugininitializercontext.env.md) | readonly | { mode: Readonly<EnvironmentMode>; packageInfo: Readonly<PackageInfo>; } | |
+| [opaqueId](./kibana-plugin-core-public.plugininitializercontext.opaqueid.md) | readonly | PluginOpaqueId | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md
index 8ee0c3a415ee3..ef531c4183e6b 100644
--- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md
+++ b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md
@@ -6,7 +6,7 @@
A symbol used to identify this plugin in the system. Needed when registering handlers or context providers.
-Signature:
+**Signature:**
```typescript
readonly opaqueId: PluginOpaqueId;
diff --git a/docs/development/core/public/kibana-plugin-core-public.pluginopaqueid.md b/docs/development/core/public/kibana-plugin-core-public.pluginopaqueid.md
index df5dc25c305c3..90d964626b812 100644
--- a/docs/development/core/public/kibana-plugin-core-public.pluginopaqueid.md
+++ b/docs/development/core/public/kibana-plugin-core-public.pluginopaqueid.md
@@ -5,7 +5,7 @@
## PluginOpaqueId type
-Signature:
+**Signature:**
```typescript
export declare type PluginOpaqueId = symbol;
diff --git a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md b/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md
index 40fd98687c619..6403f90eef489 100644
--- a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md
+++ b/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md
@@ -6,7 +6,7 @@
Public information about a registered app's [deepLinks](./kibana-plugin-core-public.appdeeplink.md)
-Signature:
+**Signature:**
```typescript
export declare type PublicAppDeepLinkInfo = Omit'aliasMatch' or 'conflict'. |
-| [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) | SavedObjectsResolveResponse\['outcome'\] | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. |
-| [saved\_object](./kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md) | SimpleSavedObject<T> | The saved object that was found. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [alias\_target\_id?](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md) | | SavedObjectsResolveResponse\['alias\_target\_id'\] | _(Optional)_ The ID of the object that the legacy URL alias points to. This is only defined when the outcome is 'aliasMatch' or 'conflict'. |
+| [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) | | SavedObjectsResolveResponse\['outcome'\] | The outcome for a successful resolve call is one of the following values:
\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID.
attributes property. |
-| [coreMigrationVersion?](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. |
-| [error?](./kibana-plugin-core-public.savedobject.error.md) | SavedObjectError | (Optional) |
-| [id](./kibana-plugin-core-public.savedobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type |
-| [migrationVersion?](./kibana-plugin-core-public.savedobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
-| [namespaces?](./kibana-plugin-core-public.savedobject.namespaces.md) | string\[\] | (Optional) Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. |
-| [originId?](./kibana-plugin-core-public.savedobject.originid.md) | string | (Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. |
-| [references](./kibana-plugin-core-public.savedobject.references.md) | SavedObjectReference\[\] | A reference to another saved object. |
-| [type](./kibana-plugin-core-public.savedobject.type.md) | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. |
-| [updated\_at?](./kibana-plugin-core-public.savedobject.updated_at.md) | string | (Optional) Timestamp of the last time this document had been updated. |
-| [version?](./kibana-plugin-core-public.savedobject.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [attributes](./kibana-plugin-core-public.savedobject.attributes.md) | | T | The data for a Saved Object is stored as an object in the attributes property. |
+| [coreMigrationVersion?](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | | string | _(Optional)_ A semver value that is used when upgrading objects between Kibana versions. |
+| [error?](./kibana-plugin-core-public.savedobject.error.md) | | SavedObjectError | _(Optional)_ |
+| [id](./kibana-plugin-core-public.savedobject.id.md) | | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type |
+| [migrationVersion?](./kibana-plugin-core-public.savedobject.migrationversion.md) | | SavedObjectsMigrationVersion | _(Optional)_ Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
+| [namespaces?](./kibana-plugin-core-public.savedobject.namespaces.md) | | string\[\] | _(Optional)_ Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. |
+| [originId?](./kibana-plugin-core-public.savedobject.originid.md) | | string | _(Optional)_ The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. |
+| [references](./kibana-plugin-core-public.savedobject.references.md) | | SavedObjectReference\[\] | A reference to another saved object. |
+| [type](./kibana-plugin-core-public.savedobject.type.md) | | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. |
+| [updated\_at?](./kibana-plugin-core-public.savedobject.updated_at.md) | | string | _(Optional)_ Timestamp of the last time this document had been updated. |
+| [version?](./kibana-plugin-core-public.savedobject.version.md) | | string | _(Optional)_ An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md
index c13b6dc429208..43ced2ff060ca 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md
@@ -6,7 +6,7 @@
Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value.
-Signature:
+**Signature:**
```typescript
migrationVersion?: SavedObjectsMigrationVersion;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md
index 3418b964ab2d7..275235b6087a7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md
@@ -6,7 +6,7 @@
Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`.
-Signature:
+**Signature:**
```typescript
namespaces?: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md
index f5bab09b9bcc0..d6c2ebfabc44c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md
@@ -6,7 +6,7 @@
The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space.
-Signature:
+**Signature:**
```typescript
originId?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md
index 09f6b8fb12b42..f4014466badc0 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md
@@ -6,7 +6,7 @@
A reference to another saved object.
-Signature:
+**Signature:**
```typescript
references: SavedObjectReference[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md
index ccaa1f1d5231c..5ffc7bab5ba02 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md
@@ -6,7 +6,7 @@
The type of Saved Object. Each plugin can define it's own custom Saved Object types.
-Signature:
+**Signature:**
```typescript
type: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md
index 111d4b676f00a..45c735cfb256c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md
@@ -6,7 +6,7 @@
Timestamp of the last time this document had been updated.
-Signature:
+**Signature:**
```typescript
updated_at?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md
index 23b8b3f40da2a..4fbe01d4af7e8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md
@@ -6,7 +6,7 @@
An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control.
-Signature:
+**Signature:**
```typescript
version?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md
index 2d7be060e28fe..b5f56db9256a7 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md
@@ -6,7 +6,7 @@
Type definition for a Saved Object attribute value
-Signature:
+**Signature:**
```typescript
export declare type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md
index 0493f52b11425..df2f8995647f8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md
@@ -6,7 +6,7 @@
The data for a Saved Object is stored as an object in the `attributes` property.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectAttributes
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md
index 388cfac2d9c33..c5e9c62a53750 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md
@@ -6,7 +6,7 @@
Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md)
-Signature:
+**Signature:**
```typescript
export declare type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md
index 87180a520090f..32f56bd2fae91 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md
@@ -4,7 +4,7 @@
## SavedObjectError.error property
-Signature:
+**Signature:**
```typescript
error: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md
index f6e8874b212b0..887b2e4630058 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md
@@ -4,7 +4,7 @@
## SavedObjectError interface
-Signature:
+**Signature:**
```typescript
export interface SavedObjectError
@@ -12,10 +12,10 @@ export interface SavedObjectError
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [error](./kibana-plugin-core-public.savedobjecterror.error.md) | string | |
-| [message](./kibana-plugin-core-public.savedobjecterror.message.md) | string | |
-| [metadata?](./kibana-plugin-core-public.savedobjecterror.metadata.md) | Record<string, unknown> | (Optional) |
-| [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) | number | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [error](./kibana-plugin-core-public.savedobjecterror.error.md) | | string | |
+| [message](./kibana-plugin-core-public.savedobjecterror.message.md) | | string | |
+| [metadata?](./kibana-plugin-core-public.savedobjecterror.metadata.md) | | Record<string, unknown> | _(Optional)_ |
+| [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) | | number | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md
index 2a51d4d1a514d..bb99b018db502 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md
@@ -4,7 +4,7 @@
## SavedObjectError.message property
-Signature:
+**Signature:**
```typescript
message: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md
index a2725f0206655..c63bef34ea740 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md
@@ -4,7 +4,7 @@
## SavedObjectError.metadata property
-Signature:
+**Signature:**
```typescript
metadata?: Recordid already exists, overwrite it's contents (default=false). |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [overwrite?](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md) | | boolean | _(Optional)_ If a document with the given id already exists, overwrite it's contents (default=false). |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md
index 20d5f84b1cf33..5945d93ff5d06 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md
@@ -6,7 +6,7 @@
If a document with the given `id` already exists, overwrite it's contents (default=false).
-Signature:
+**Signature:**
```typescript
overwrite?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md
index 6a8fd52a4dc49..a13f283fec557 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md
@@ -4,7 +4,7 @@
## SavedObjectsBulkResolveObject.id property
-Signature:
+**Signature:**
```typescript
id: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md
index fbff3d3bd8f25..bc4d6ff3b4866 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md
@@ -5,7 +5,7 @@
## SavedObjectsBulkResolveObject interface
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsBulkResolveObject
@@ -13,8 +13,8 @@ export interface SavedObjectsBulkResolveObject
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) | string | |
-| [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) | string | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) | | string | |
+| [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) | | string | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md
index 09c7991012da8..1a04bcc3a208c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md
@@ -4,7 +4,7 @@
## SavedObjectsBulkResolveObject.type property
-Signature:
+**Signature:**
```typescript
type: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md
index e34bf6fe32618..ef158ffe428d8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md
@@ -5,7 +5,7 @@
## SavedObjectsBulkResolveResponse interface
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsBulkResolveResponseid already exists, overwrite it's contents (default=false). |
-| [references?](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) | SavedObjectReference\[\] | (Optional) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [coreMigrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) | | string | _(Optional)_ A semver value that is used when upgrading objects between Kibana versions. |
+| [id?](./kibana-plugin-core-public.savedobjectscreateoptions.id.md) | | string | _(Optional)_ (Not recommended) Specify an id instead of having the saved objects service generate one for you. |
+| [migrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md) | | SavedObjectsMigrationVersion | _(Optional)_ Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
+| [overwrite?](./kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md) | | boolean | _(Optional)_ If a document with the given id already exists, overwrite it's contents (default=false). |
+| [references?](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) | | SavedObjectReference\[\] | _(Optional)_ |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md
index 4ea4386303a58..38dfe841c05dd 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md
@@ -6,7 +6,7 @@
Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value.
-Signature:
+**Signature:**
```typescript
migrationVersion?: SavedObjectsMigrationVersion;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md
index aa3e102e6c042..d77cbe69a08cb 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md
@@ -6,7 +6,7 @@
If a document with the given `id` already exists, overwrite it's contents (default=false).
-Signature:
+**Signature:**
```typescript
overwrite?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md
index ef67cdb771630..d7ef49ea46e11 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md
@@ -4,7 +4,7 @@
## SavedObjectsCreateOptions.references property
-Signature:
+**Signature:**
```typescript
references?: SavedObjectReference[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md
index f1c2fd08a21f1..62aeee9e6c788 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md
@@ -6,7 +6,7 @@
The search operator to use with the provided filter. Defaults to `OR`
-Signature:
+**Signature:**
```typescript
defaultSearchOperator?: 'AND' | 'OR';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md
index 39bc1d3161bd4..1009e5f960172 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md
@@ -6,7 +6,7 @@
An array of fields to include in the results
-Signature:
+**Signature:**
```typescript
fields?: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md
index 2c20fe2dab00f..4b17db6c1dd66 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.filter property
-Signature:
+**Signature:**
```typescript
filter?: string | KueryNode;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md
index 25ce8fa7b6018..f05b26d5162cf 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md
@@ -6,7 +6,7 @@
Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references.
-Signature:
+**Signature:**
```typescript
hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md
index 3681d1c9d34d9..308fa110d8fb2 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md
@@ -6,7 +6,7 @@
The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`
-Signature:
+**Signature:**
```typescript
hasReferenceOperator?: 'AND' | 'OR';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md
index f429911476307..b29d997fb3cd0 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md
@@ -5,7 +5,7 @@
## SavedObjectsFindOptions interface
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsFindOptions
@@ -13,24 +13,24 @@ export interface SavedObjectsFindOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [defaultSearchOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | 'AND' \| 'OR' | (Optional) The search operator to use with the provided filter. Defaults to OR |
-| [fields?](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) | string\[\] | (Optional) An array of fields to include in the results |
-| [filter?](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) | string \| KueryNode | (Optional) |
-| [hasReference?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | (Optional) Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. |
-| [hasReferenceOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) | 'AND' \| 'OR' | (Optional) The operator to use when searching by multiple references using the hasReference option. Defaults to OR |
-| [namespaces?](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) | string\[\] | (Optional) |
-| [page?](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | number | (Optional) |
-| [perPage?](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | number | (Optional) |
-| [pit?](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) | SavedObjectsPitParams | (Optional) Search against a specific Point In Time (PIT) that you've opened with . |
-| [preference?](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query \* |
-| [rootSearchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. |
-| [search?](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) | string | (Optional) Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information |
-| [searchAfter?](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) | estypes.Id\[\] | (Optional) Use the sort values from the previous page to retrieve the next page of results. |
-| [searchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information |
-| [sortField?](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) | string | (Optional) |
-| [sortOrder?](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) | estypes.SearchSortOrder | (Optional) |
-| [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) | string \| string\[\] | |
-| [typeToNamespacesMap?](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) | Map<string, string\[\] \| undefined> | (Optional) This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [defaultSearchOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | | 'AND' \| 'OR' | _(Optional)_ The search operator to use with the provided filter. Defaults to OR |
+| [fields?](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) | | string\[\] | _(Optional)_ An array of fields to include in the results |
+| [filter?](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) | | string \| KueryNode | _(Optional)_ |
+| [hasReference?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | _(Optional)_ Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. |
+| [hasReferenceOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) | | 'AND' \| 'OR' | _(Optional)_ The operator to use when searching by multiple references using the hasReference option. Defaults to OR |
+| [namespaces?](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) | | string\[\] | _(Optional)_ |
+| [page?](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | | number | _(Optional)_ |
+| [perPage?](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | | number | _(Optional)_ |
+| [pit?](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) | | SavedObjectsPitParams | _(Optional)_ Search against a specific Point In Time (PIT) that you've opened with . |
+| [preference?](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) | | string | _(Optional)_ An optional ES preference value to be used for the query \* |
+| [rootSearchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) | | string\[\] | _(Optional)_ The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. |
+| [search?](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) | | string | _(Optional)_ Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information |
+| [searchAfter?](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) | | estypes.Id\[\] | _(Optional)_ Use the sort values from the previous page to retrieve the next page of results. |
+| [searchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) | | string\[\] | _(Optional)_ The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information |
+| [sortField?](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) | | string | _(Optional)_ |
+| [sortOrder?](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) | | estypes.SearchSortOrder | _(Optional)_ |
+| [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) | | string \| string\[\] | |
+| [typeToNamespacesMap?](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) | | Map<string, string\[\] \| undefined> | _(Optional)_ This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md
index 9cc9d64db1f65..2d0e88b337090 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.namespaces property
-Signature:
+**Signature:**
```typescript
namespaces?: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md
index e009a4ac8e393..c6495fa34d72d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.page property
-Signature:
+**Signature:**
```typescript
page?: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md
index 0c6f3464d194c..9b7da979eed97 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.perPage property
-Signature:
+**Signature:**
```typescript
perPage?: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md
index 2284a4d8d210d..66700c88e3c33 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md
@@ -6,7 +6,7 @@
Search against a specific Point In Time (PIT) that you've opened with .
-Signature:
+**Signature:**
```typescript
pit?: SavedObjectsPitParams;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md
index 8a30cb99c57bc..b8ab6755f627e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md
@@ -6,7 +6,7 @@
An optional ES preference value to be used for the query \*
-Signature:
+**Signature:**
```typescript
preference?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md
index faa971509eca2..57d5054feac5a 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md
@@ -6,7 +6,7 @@
The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not be modified. If used in conjunction with `searchFields`, both are concatenated together.
-Signature:
+**Signature:**
```typescript
rootSearchFields?: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md
index a7d149b58be02..b30b774c1bc36 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md
@@ -6,7 +6,7 @@
Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information
-Signature:
+**Signature:**
```typescript
search?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md
index 7016e1f1b72de..16b46d1f81671 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md
@@ -6,7 +6,7 @@
Use the sort values from the previous page to retrieve the next page of results.
-Signature:
+**Signature:**
```typescript
searchAfter?: estypes.Id[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md
index c99864ac8c046..5f9cc853dd565 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md
@@ -6,7 +6,7 @@
The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information
-Signature:
+**Signature:**
```typescript
searchFields?: string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md
index 7b5072c0e19df..cec9ca13c5454 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.sortField property
-Signature:
+**Signature:**
```typescript
sortField?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md
index 506fb9041e353..fb02fda027b74 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.sortOrder property
-Signature:
+**Signature:**
```typescript
sortOrder?: estypes.SearchSortOrder;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md
index b4ce216fab1ad..8a69ff31003ab 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md
@@ -4,7 +4,7 @@
## SavedObjectsFindOptions.type property
-Signature:
+**Signature:**
```typescript
type: string | string[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md
index 4af8c9ddeaff4..e872b2478da62 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md
@@ -6,7 +6,7 @@
This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace.
-Signature:
+**Signature:**
```typescript
typeToNamespacesMap?: Mapoverwrite is specified, an attempt was made to overwrite an existing object. |
-| [title?](./kibana-plugin-core-public.savedobjectsimportfailure.title.md) | string | (Optional) |
-| [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) | string | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [error](./kibana-plugin-core-public.savedobjectsimportfailure.error.md) | | SavedObjectsImportConflictError \| SavedObjectsImportAmbiguousConflictError \| SavedObjectsImportUnsupportedTypeError \| SavedObjectsImportMissingReferencesError \| SavedObjectsImportUnknownError | |
+| [id](./kibana-plugin-core-public.savedobjectsimportfailure.id.md) | | string | |
+| [meta](./kibana-plugin-core-public.savedobjectsimportfailure.meta.md) | | { title?: string; icon?: string; } | |
+| [overwrite?](./kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md) | | boolean | _(Optional)_ If overwrite is specified, an attempt was made to overwrite an existing object. |
+| [title?](./kibana-plugin-core-public.savedobjectsimportfailure.title.md) | | string | _(Optional)_ |
+| [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) | | string | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md
index 4ea9455098035..4af9f9ca73263 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md
@@ -4,7 +4,7 @@
## SavedObjectsImportFailure.meta property
-Signature:
+**Signature:**
```typescript
meta: {
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md
index 579a16697b406..d4a6b134f7e47 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md
@@ -6,7 +6,7 @@
If `overwrite` is specified, an attempt was made to overwrite an existing object.
-Signature:
+**Signature:**
```typescript
overwrite?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.title.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.title.md
index 0024358bda030..a54591e4dc83f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.title.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.title.md
@@ -9,7 +9,7 @@
> Use `meta.title` instead
>
-Signature:
+**Signature:**
```typescript
title?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md
index 68411093a92ce..2fabd2da676e4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportFailure.type property
-Signature:
+**Signature:**
```typescript
type: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md
index 6c03ab263084c..ac384e430effe 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md
@@ -6,7 +6,7 @@
Represents a failure to import due to missing references.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportMissingReferencesError
@@ -14,8 +14,8 @@ export interface SavedObjectsImportMissingReferencesError
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) | Array<{ type: string; id: string; }> | |
-| [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) | 'missing\_references' | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) | | Array<{ type: string; id: string; }> | |
+| [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) | | 'missing\_references' | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md
index b479956ed7125..52629ac53f278 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md
@@ -4,7 +4,7 @@
## SavedObjectsImportMissingReferencesError.references property
-Signature:
+**Signature:**
```typescript
references: Array<{
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md
index 6c0caa258c5fb..1c78c60eb937c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportMissingReferencesError.type property
-Signature:
+**Signature:**
```typescript
type: 'missing_references';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md
index 073eac20b04ac..a17cbacb3d655 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md
@@ -4,7 +4,7 @@
## SavedObjectsImportResponse.errors property
-Signature:
+**Signature:**
```typescript
errors?: SavedObjectsImportFailure[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md
index 5b6139723a101..d0bc3e7b4cf91 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md
@@ -6,7 +6,7 @@
The response describing the result of an import.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportResponse
@@ -14,11 +14,11 @@ export interface SavedObjectsImportResponse
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [errors?](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) | SavedObjectsImportFailure\[\] | (Optional) |
-| [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) | boolean | |
-| [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) | number | |
-| [successResults?](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) | SavedObjectsImportSuccess\[\] | (Optional) |
-| [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) | SavedObjectsImportWarning\[\] | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [errors?](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) | | SavedObjectsImportFailure\[\] | _(Optional)_ |
+| [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) | | boolean | |
+| [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) | | number | |
+| [successResults?](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) | | SavedObjectsImportSuccess\[\] | _(Optional)_ |
+| [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) | | SavedObjectsImportWarning\[\] | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md
index 3c6492f340418..520ed5fbcb1ab 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md
@@ -4,7 +4,7 @@
## SavedObjectsImportResponse.success property
-Signature:
+**Signature:**
```typescript
success: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md
index caa296c3ef291..6c96bf8d51e31 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md
@@ -4,7 +4,7 @@
## SavedObjectsImportResponse.successCount property
-Signature:
+**Signature:**
```typescript
successCount: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md
index 51a47b6c2d953..ed0dbe9837688 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md
@@ -4,7 +4,7 @@
## SavedObjectsImportResponse.successResults property
-Signature:
+**Signature:**
```typescript
successResults?: SavedObjectsImportSuccess[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md
index 2e55a2e30f9cb..a2bd2244c9b97 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md
@@ -4,7 +4,7 @@
## SavedObjectsImportResponse.warnings property
-Signature:
+**Signature:**
```typescript
warnings: SavedObjectsImportWarning[];
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md
index f60c713973d58..f5cd781b83591 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md
@@ -6,7 +6,7 @@
If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected.
-Signature:
+**Signature:**
```typescript
createNewCopy?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md
index 5131d1d01ff02..724d9c31ed680 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md
@@ -6,7 +6,7 @@
The object ID that will be created or overwritten. If not specified, the `id` field will be used.
-Signature:
+**Signature:**
```typescript
destinationId?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md
index 961c61a2cba6c..d0f4f7f93ba93 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md
@@ -4,7 +4,7 @@
## SavedObjectsImportRetry.id property
-Signature:
+**Signature:**
```typescript
id: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md
index 4ce833f2966cc..563b97f155944 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md
@@ -6,7 +6,7 @@
If `ignoreMissingReferences` is specified, reference validation will be skipped for this object.
-Signature:
+**Signature:**
```typescript
ignoreMissingReferences?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md
index 80a3145ae7e55..3b49905249a3c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md
@@ -6,7 +6,7 @@
Describes a retry operation for importing a saved object.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportRetry
@@ -14,13 +14,13 @@ export interface SavedObjectsImportRetry
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) | boolean | (Optional) If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. |
-| [destinationId?](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) | string | (Optional) The object ID that will be created or overwritten. If not specified, the id field will be used. |
-| [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) | string | |
-| [ignoreMissingReferences?](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) | boolean | (Optional) If ignoreMissingReferences is specified, reference validation will be skipped for this object. |
-| [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | boolean | |
-| [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) | Array<{ type: string; from: string; to: string; }> | |
-| [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) | string | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) | | boolean | _(Optional)_ If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. |
+| [destinationId?](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) | | string | _(Optional)_ The object ID that will be created or overwritten. If not specified, the id field will be used. |
+| [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) | | string | |
+| [ignoreMissingReferences?](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) | | boolean | _(Optional)_ If ignoreMissingReferences is specified, reference validation will be skipped for this object. |
+| [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | | boolean | |
+| [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) | | Array<{ type: string; from: string; to: string; }> | |
+| [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) | | string | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md
index 51ea151a9cdb3..0554560e9d512 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md
@@ -4,7 +4,7 @@
## SavedObjectsImportRetry.overwrite property
-Signature:
+**Signature:**
```typescript
overwrite: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md
index 2b0fd703c0d81..7b560624f4b17 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md
@@ -4,7 +4,7 @@
## SavedObjectsImportRetry.replaceReferences property
-Signature:
+**Signature:**
```typescript
replaceReferences: Array<{
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md
index 86ccd13d7ff55..9b965701134c1 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportRetry.type property
-Signature:
+**Signature:**
```typescript
type: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md
index 304779a1589f9..556b254b8eaf5 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md
@@ -6,7 +6,7 @@
A simple informative warning that will be displayed to the user.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportSimpleWarning
@@ -14,8 +14,8 @@ export interface SavedObjectsImportSimpleWarning
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) | string | The translated message to display to the user |
-| [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) | 'simple' | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) | | string | The translated message to display to the user |
+| [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) | | 'simple' | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md
index 42c94e14e3d28..3804b11332f76 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md
@@ -6,7 +6,7 @@
The translated message to display to the user
-Signature:
+**Signature:**
```typescript
message: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md
index 86a4cbfa434e7..5649a45d23e7f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportSimpleWarning.type property
-Signature:
+**Signature:**
```typescript
type: 'simple';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md
index 0598691fbd525..6d1e4e04f226d 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md
@@ -9,7 +9,7 @@
> If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, this field will be redundant and can be removed.
>
-Signature:
+**Signature:**
```typescript
createNewCopy?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md
index 55611a77aeb67..a4bb88ade1302 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md
@@ -6,7 +6,7 @@
If `destinationId` is specified, the new object has a new ID that is different from the import ID.
-Signature:
+**Signature:**
```typescript
destinationId?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md
index 6d6271e37dffe..ec1975c062041 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md
@@ -4,7 +4,7 @@
## SavedObjectsImportSuccess.id property
-Signature:
+**Signature:**
```typescript
id: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md
index 57ca4b7a787f6..634c9ecfa0503 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md
@@ -6,7 +6,7 @@
Represents a successful import.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportSuccess
@@ -14,12 +14,12 @@ export interface SavedObjectsImportSuccess
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) | boolean | (Optional) |
-| [destinationId?](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) | string | (Optional) If destinationId is specified, the new object has a new ID that is different from the import ID. |
-| [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) | string | |
-| [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) | { title?: string; icon?: string; } | |
-| [overwrite?](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) | boolean | (Optional) If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). |
-| [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) | string | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) | | boolean | _(Optional)_ |
+| [destinationId?](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) | | string | _(Optional)_ If destinationId is specified, the new object has a new ID that is different from the import ID. |
+| [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) | | string | |
+| [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) | | { title?: string; icon?: string; } | |
+| [overwrite?](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) | | boolean | _(Optional)_ If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). |
+| [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) | | string | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md
index d1c7bc92b5cbf..9264b00340ca4 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md
@@ -4,7 +4,7 @@
## SavedObjectsImportSuccess.meta property
-Signature:
+**Signature:**
```typescript
meta: {
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md
index 18ae2ca9bee3d..e61c447730b0e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md
@@ -6,7 +6,7 @@
If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution).
-Signature:
+**Signature:**
```typescript
overwrite?: boolean;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md
index 6ac14455d281f..843a375d3283f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportSuccess.type property
-Signature:
+**Signature:**
```typescript
type: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md
index fc78e04dee8ac..807883fb78939 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md
@@ -6,7 +6,7 @@
Represents a failure to import due to an unknown reason.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportUnknownError
@@ -14,9 +14,9 @@ export interface SavedObjectsImportUnknownError
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) | string | |
-| [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) | number | |
-| [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) | 'unknown' | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) | | string | |
+| [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) | | number | |
+| [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) | | 'unknown' | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md
index 4445b3527657f..014bc6a64b839 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md
@@ -4,7 +4,7 @@
## SavedObjectsImportUnknownError.message property
-Signature:
+**Signature:**
```typescript
message: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md
index 929631cf84b2e..00974108a10bf 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md
@@ -4,7 +4,7 @@
## SavedObjectsImportUnknownError.statusCode property
-Signature:
+**Signature:**
```typescript
statusCode: number;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md
index 9febc279bb093..a45475dd86bb8 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportUnknownError.type property
-Signature:
+**Signature:**
```typescript
type: 'unknown';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md
index de805f05a12e9..656c8da7acc04 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md
@@ -6,7 +6,7 @@
Represents a failure to import due to having an unsupported saved object type.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsImportUnsupportedTypeError
@@ -14,7 +14,7 @@ export interface SavedObjectsImportUnsupportedTypeError
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) | 'unsupported\_type' | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) | | 'unsupported\_type' | |
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md
index ca8c2a419095f..c21ae8a35535f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md
@@ -4,7 +4,7 @@
## SavedObjectsImportUnsupportedTypeError.type property
-Signature:
+**Signature:**
```typescript
type: 'unsupported_type';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md
index a9a9a70774970..a07dd0ea7356c 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md
@@ -8,7 +8,7 @@ Composite type of all the possible types of import warnings.
See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details.
-Signature:
+**Signature:**
```typescript
export declare type SavedObjectsImportWarning = SavedObjectsImportSimpleWarning | SavedObjectsImportActionRequiredWarning;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md
index f1132b98bc84e..dc6bd07993403 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md
@@ -6,7 +6,7 @@
Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value.
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsMigrationVersion
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md
index cf5e6cb29a532..97a6fd6e59286 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md
@@ -6,7 +6,7 @@
The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global.
-Signature:
+**Signature:**
```typescript
export declare type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic';
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md
index 07c55ae922363..bd3ba6e1d829e 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md
@@ -6,7 +6,7 @@
The ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`.
-Signature:
+**Signature:**
```typescript
alias_target_id?: string;
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md
index 6364493a9ef09..82a284e5ca615 100644
--- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md
@@ -5,7 +5,7 @@
## SavedObjectsResolveResponse interface
-Signature:
+**Signature:**
```typescript
export interface SavedObjectsResolveResponse'aliasMatch' or 'conflict'. |
-| [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. |
-| [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) | SavedObject<T> | The saved object that was found. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [alias\_target\_id?](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md) | | string | _(Optional)_ The ID of the object that the legacy URL alias points to. This is only defined when the outcome is 'aliasMatch' or 'conflict'. |
+| [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) | | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:
\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID.
readonly | Action | The last action dispatched on the history stack. |
+| [block](./kibana-plugin-core-public.scopedhistory.block.md) | | (prompt?: boolean \| string \| TransitionPromptHook<HistoryLocationState>) => UnregisterCallback | Add a block prompt requesting user confirmation when navigating away from the current page. |
| [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) | | (location: LocationDescriptorObject<HistoryLocationState>, { prependBasePath }?: { prependBasePath?: boolean \| undefined; }) => Href | Creates an href (string) to the location. If prependBasePath is true (default), it will prepend the location's path with the scoped history basePath. |
| [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) | | (basePath: string) => ScopedHistory<HistoryLocationState> | Creates a ScopedHistory for a subpath of this ScopedHistory. Useful for applications that may have sub-apps that do not need access to the containing application's history. |
| [go](./kibana-plugin-core-public.scopedhistory.go.md) | | (n: number) => void | Send the user forward or backwards in the history stack. |
| [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) | | () => void | Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available backwards, this is a no-op. |
| [goForward](./kibana-plugin-core-public.scopedhistory.goforward.md) | | () => void | Send the user one location forward in the history stack. Equivalent to calling [ScopedHistory.go(1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available forwards, this is a no-op. |
-| [length](./kibana-plugin-core-public.scopedhistory.length.md) | | number | The number of entries in the history stack, including all entries forwards and backwards from the current location. |
+| [length](./kibana-plugin-core-public.scopedhistory.length.md) | readonly | number | The number of entries in the history stack, including all entries forwards and backwards from the current location. |
| [listen](./kibana-plugin-core-public.scopedhistory.listen.md) | | (listener: (location: Location<HistoryLocationState>, action: Action) => void) => UnregisterCallback | Adds a listener for location updates. |
-| [location](./kibana-plugin-core-public.scopedhistory.location.md) | | Location<HistoryLocationState> | The current location of the history stack. |
-| [push](./kibana-plugin-core-public.scopedhistory.push.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. |
-| [replace](./kibana-plugin-core-public.scopedhistory.replace.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Replaces the current location in the history stack. Does not remove forward or backward entries. |
+| [location](./kibana-plugin-core-public.scopedhistory.location.md) | readonly | Location<HistoryLocationState> | The current location of the history stack. |
+| [push](./kibana-plugin-core-public.scopedhistory.push.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState) => void | Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. |
+| [replace](./kibana-plugin-core-public.scopedhistory.replace.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState) => void | Replaces the current location in the history stack. Does not remove forward or backward entries. |
diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md
index 226203502c5e0..20451a4a9a300 100644
--- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md
+++ b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md
@@ -6,8 +6,8 @@
Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed.
-Signature:
+**Signature:**
```typescript
-push: (pathOrLocation: Path | LocationDescriptorObjectError instance. |
| options | ErrorToastOptions | [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) |
-Returns:
+**Returns:**
Toast
diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md
index 7029482663155..8ca5304d35c52 100644
--- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md
+++ b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md
@@ -6,7 +6,7 @@
Adds a new toast pre-configured with the info color and info icon.
-Signature:
+**Signature:**
```typescript
addInfo(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
@@ -17,9 +17,9 @@ addInfo(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) |
-| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
+| options | ToastOptions | _(Optional)_ a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
-Returns:
+**Returns:**
Toast
diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md
index b9cf4da3b43af..fb563001f4e9f 100644
--- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md
+++ b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md
@@ -6,7 +6,7 @@
Adds a new toast pre-configured with the success color and check icon.
-Signature:
+**Signature:**
```typescript
addSuccess(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
@@ -17,9 +17,9 @@ addSuccess(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) |
-| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
+| options | ToastOptions | _(Optional)_ a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
-Returns:
+**Returns:**
Toast
diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md
index 790af0d26220a..687455cb7f358 100644
--- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md
+++ b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md
@@ -6,7 +6,7 @@
Adds a new toast pre-configured with the warning color and help icon.
-Signature:
+**Signature:**
```typescript
addWarning(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
@@ -17,9 +17,9 @@ addWarning(toastOrTitle: ToastInput, options?: ToastOptions): Toast;
| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) |
-| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
+| options | ToastOptions | _(Optional)_ a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) |
-Returns:
+**Returns:**
Toast
diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md
index 275d30fd54e0f..c70fa3eba6162 100644
--- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md
+++ b/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md
@@ -6,12 +6,12 @@
Observable of the toast messages to show to the user.
-Signature:
+**Signature:**
```typescript
get$(): Rx.Observable_(Optional)_ index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI.
settings without order defined will be displayed last and ordered by name
| +| [readonly?](./kibana-plugin-core-public.uisettingsparams.readonly.md) | | boolean | _(Optional)_ a flag indicating that value cannot be changed | +| [requiresPageReload?](./kibana-plugin-core-public.uisettingsparams.requirespagereload.md) | | boolean | _(Optional)_ a flag indicating whether new value applying requires page reloading | +| [schema](./kibana-plugin-core-public.uisettingsparams.schema.md) | | Type<T> | | +| [sensitive?](./kibana-plugin-core-public.uisettingsparams.sensitive.md) | | boolean | _(Optional)_ a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. | +| [type?](./kibana-plugin-core-public.uisettingsparams.type.md) | | UiSettingsType | _(Optional)_ defines a type of UI element [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) | +| [value?](./kibana-plugin-core-public.uisettingsparams.value.md) | | T | _(Optional)_ default value to fall back to if a user doesn't provide any | diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md index c6d288ec8f542..cc6fc2596de3b 100644 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md +++ b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md @@ -11,7 +11,7 @@ Metric to track once this property changes -Signature: +**Signature:** ```typescript metric?: { diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md index a86ba4d49725a..fafb7f5571826 100644 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md +++ b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md @@ -6,7 +6,7 @@ title in the UI -Signature: +**Signature:** ```typescript name?: string; diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md index 35e90878a0dab..543e66ebba646 100644 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md +++ b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md @@ -6,7 +6,7 @@ text labels for 'select' type UI element -Signature: +**Signature:** ```typescript optionLabels?: Recordkibana.json file at it's root directory that follows to define static plugin information required to load the plugin.A plugin's server/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. 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. |
+| [kibana-plugin-core-server](./kibana-plugin-core-server.md) | The Kibana Core APIs for server-side plugins.
A plugin requires a kibana.json file at it's root directory that follows to define static plugin information required to load the plugin.
A plugin's server/index file must contain a named import, plugin, that implements which returns an object that implements .
The plugin integrates with the core system via lifecycle events: setup, start, and stop. 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.
src/core/server/deprecations/README.mdx |
-| [requireRestart?](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) | boolean | (Optional) (optional) specify the fix for this deprecation requires a full kibana restart. |
-| [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) | string | The title of the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [correctiveActions](./kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md) | | { api?: { path: string; method: 'POST' \| 'PUT'; body?: { \[key: string\]: any; }; omitContextFromBody?: boolean; }; manualSteps: string\[\]; } | corrective action needed to fix this deprecation. |
+| [deprecationType?](./kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md) | | 'config' \| 'feature' | _(Optional)_ (optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab.
Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations.
| +| [documentationUrl?](./kibana-plugin-core-server.basedeprecationdetails.documentationurl.md) | | string | _(Optional)_ (optional) link to the documentation for more details on the deprecation. | +| [level](./kibana-plugin-core-server.basedeprecationdetails.level.md) | | 'warning' \| 'critical' \| 'fetch\_error' | levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. | +| [message](./kibana-plugin-core-server.basedeprecationdetails.message.md) | | string | The description message to be displayed for the deprecation. Check the README for writing deprecations insrc/core/server/deprecations/README.mdx |
+| [requireRestart?](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) | | boolean | _(Optional)_ (optional) specify the fix for this deprecation requires a full kibana restart. |
+| [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) | | string | The title of the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx |
diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md
index 5802bc316cc08..0f2985b5e86c7 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md
@@ -6,7 +6,7 @@
The description message to be displayed for the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx`
-Signature:
+**Signature:**
```typescript
message: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md
index 3f589600d0458..2755f274038c0 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md
@@ -6,7 +6,7 @@
(optional) specify the fix for this deprecation requires a full kibana restart.
-Signature:
+**Signature:**
```typescript
requireRestart?: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md
index b6788a4faa7c5..1692bdaafe673 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md
@@ -6,7 +6,7 @@
The title of the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx`
-Signature:
+**Signature:**
```typescript
title: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md b/docs/development/core/server/kibana-plugin-core-server.basepath.get.md
index b35c6e657b01f..773f77a10d6c9 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.get.md
@@ -6,7 +6,7 @@
returns `basePath` value, specific for an incoming request.
-Signature:
+**Signature:**
```typescript
get: (request: KibanaRequest) => string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.md
index 4fae861cf1659..626480090b1a8 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.md
@@ -6,7 +6,7 @@
Access or manipulate the Kibana base path
-Signature:
+**Signature:**
```typescript
export declare class BasePath
@@ -22,8 +22,8 @@ The constructor for this class is marked as internal. Third-party code should no
| --- | --- | --- | --- |
| [get](./kibana-plugin-core-server.basepath.get.md) | | (request: KibanaRequest) => string | returns basePath value, specific for an incoming request. |
| [prepend](./kibana-plugin-core-server.basepath.prepend.md) | | (path: string) => string | Prepends path with the basePath. |
-| [publicBaseUrl?](./kibana-plugin-core-server.basepath.publicbaseurl.md) | | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). |
+| [publicBaseUrl?](./kibana-plugin-core-server.basepath.publicbaseurl.md) | readonly | string | _(Optional)_ The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). |
| [remove](./kibana-plugin-core-server.basepath.remove.md) | | (path: string) => string | Removes the prepended basePath from the path. |
-| [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) | | string | returns the server's basePathSee [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request |
+| [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) | readonly | string | returns the server's basePath
See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request
| | [set](./kibana-plugin-core-server.basepath.set.md) | | (request: KibanaRequest, requestSpecificBasePath: string) => void | setsbasePath value, specific for an incoming request. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md b/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md
index 94ddf74372cc4..c1f7a15c76603 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md
@@ -6,7 +6,7 @@
Prepends `path` with the basePath.
-Signature:
+**Signature:**
```typescript
prepend: (path: string) => string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md b/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md
index 65842333ac246..763d76069b4d6 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md
@@ -6,7 +6,7 @@
The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md).
-Signature:
+**Signature:**
```typescript
readonly publicBaseUrl?: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md b/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md
index 13ccd9db6ab86..424087c0b70de 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md
@@ -6,7 +6,7 @@
Removes the prepended basePath from the `path`.
-Signature:
+**Signature:**
```typescript
remove: (path: string) => string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md
index 01fc9b69055f0..cc0e7c97df223 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md
@@ -8,7 +8,7 @@ returns the server's basePath
See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request
-Signature:
+**Signature:**
```typescript
readonly serverBasePath: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md b/docs/development/core/server/kibana-plugin-core-server.basepath.set.md
index b90767022d594..d2234f55fa842 100644
--- a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md
+++ b/docs/development/core/server/kibana-plugin-core-server.basepath.set.md
@@ -6,7 +6,7 @@
sets `basePath` value, specific for an incoming request.
-Signature:
+**Signature:**
```typescript
set: (request: KibanaRequest, requestSpecificBasePath: string) => void;
diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md
index 7b93d3b885d23..bfe27a6ec2b09 100644
--- a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md
+++ b/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md
@@ -6,7 +6,7 @@
Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options.
-Signature:
+**Signature:**
```typescript
catalogue: RecordRegister a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) to be used to change the default state of the [Capabilities](./kibana-plugin-core-server.capabilities.md) entries when resolving them.
A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored.
| diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md index 9122f7e0f11ed..fb80c7108e8f8 100644 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md +++ b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md @@ -6,7 +6,7 @@ Register a [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) to be used to provide [Capabilities](./kibana-plugin-core-server.capabilities.md) when resolving them. -Signature: +**Signature:** ```typescript registerProvider(provider: CapabilitiesProvider): void; @@ -18,7 +18,7 @@ registerProvider(provider: CapabilitiesProvider): void; | --- | --- | --- | | provider | CapabilitiesProvider | | -Returns: +**Returns:** void diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md index c07703c1f365f..72d65dc4ac181 100644 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md +++ b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md @@ -8,7 +8,7 @@ Register a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitch A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored. -Signature: +**Signature:** ```typescript registerSwitcher(switcher: CapabilitiesSwitcher): void; @@ -20,7 +20,7 @@ registerSwitcher(switcher: CapabilitiesSwitcher): void; | --- | --- | --- | | switcher | CapabilitiesSwitcher | | -Returns: +**Returns:** void diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md index 217a782be9d8b..cfa776810eb89 100644 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md +++ b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md @@ -6,7 +6,7 @@ APIs to access the application [Capabilities](./kibana-plugin-core-server.capabilities.md). -Signature: +**Signature:** ```typescript export interface CapabilitiesStart diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md index a9dc279526065..44467405063e2 100644 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md +++ b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md @@ -6,7 +6,7 @@ Resolve the [Capabilities](./kibana-plugin-core-server.capabilities.md) to be used for given request -Signature: +**Signature:** ```typescript resolveCapabilities(request: KibanaRequest, options?: ResolveCapabilitiesOptions): Promisestatic | CspConfig | |
-| [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) | | boolean | |
-| [header](./kibana-plugin-core-server.cspconfig.header.md) | | string | |
-| [rules](./kibana-plugin-core-server.cspconfig.rules.md) | | string\[\] | |
-| [strict](./kibana-plugin-core-server.cspconfig.strict.md) | | boolean | |
-| [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) | | boolean | |
+| [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) | static
readonly
readonly | boolean | |
+| [header](./kibana-plugin-core-server.cspconfig.header.md) | readonly | string | |
+| [rules](./kibana-plugin-core-server.cspconfig.rules.md) | readonly | string\[\] | |
+| [strict](./kibana-plugin-core-server.cspconfig.strict.md) | readonly | boolean | |
+| [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) | readonly | boolean | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.rules.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.rules.md
index 2bc73345fe0d0..222e0b35eb1db 100644
--- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.rules.md
+++ b/docs/development/core/server/kibana-plugin-core-server.cspconfig.rules.md
@@ -4,7 +4,7 @@
## CspConfig.rules property
-Signature:
+**Signature:**
```typescript
readonly rules: string[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md
index 303d04373db73..e3800adcdafcb 100644
--- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md
+++ b/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md
@@ -4,7 +4,7 @@
## CspConfig.strict property
-Signature:
+**Signature:**
```typescript
readonly strict: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md
index 70c93c57864b7..5680e0e2c7c85 100644
--- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md
+++ b/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md
@@ -4,7 +4,7 @@
## CspConfig.warnLegacyBrowsers property
-Signature:
+**Signature:**
```typescript
readonly warnLegacyBrowsers: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md
index da37b33fe1bd0..3e10ed10a1725 100644
--- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md
+++ b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md
@@ -6,7 +6,7 @@
HTTP message to send to the client
-Signature:
+**Signature:**
```typescript
body?: T;
diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md
index bbd97ab517d29..f547eecd0802b 100644
--- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md
+++ b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md
@@ -6,7 +6,7 @@
Bypass the default error formatting
-Signature:
+**Signature:**
```typescript
bypassErrorFormat?: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md
index f317037482575..e4b6760badb5c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md
+++ b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md
@@ -6,7 +6,7 @@
HTTP Headers with additional information about response
-Signature:
+**Signature:**
```typescript
headers?: ResponseHeaders;
diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md
index 84cb55f5c1054..71eb0b3727703 100644
--- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md
+++ b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md
@@ -6,7 +6,7 @@
HTTP response parameters for a response with adjustable status code.
-Signature:
+**Signature:**
```typescript
export interface CustomHttpResponseOptionsrequiredPlugins. |
-| [requiredPlugins](./kibana-plugin-core-server.discoveredplugin.requiredplugins.md) | readonly PluginName\[\] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. |
-| [type](./kibana-plugin-core-server.discoveredplugin.type.md) | PluginType | Type of the plugin, defaults to standard. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [configPath](./kibana-plugin-core-server.discoveredplugin.configpath.md) | readonly | ConfigPath | Root configuration path used by the plugin, defaults to "id" in snake\_case format. |
+| [enabledOnAnonymousPages?](./kibana-plugin-core-server.discoveredplugin.enabledonanonymouspages.md) | readonly | boolean | _(Optional)_ Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. |
+| [id](./kibana-plugin-core-server.discoveredplugin.id.md) | readonly | PluginName | Identifier of the plugin. |
+| [optionalPlugins](./kibana-plugin-core-server.discoveredplugin.optionalplugins.md) | readonly | readonly PluginName\[\] | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. |
+| [requiredBundles](./kibana-plugin-core-server.discoveredplugin.requiredbundles.md) | readonly | readonly PluginName\[\] | List of plugin ids that this plugin's UI code imports modules from that are not in requiredPlugins. |
+| [requiredPlugins](./kibana-plugin-core-server.discoveredplugin.requiredplugins.md) | readonly | readonly PluginName\[\] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. |
+| [type](./kibana-plugin-core-server.discoveredplugin.type.md) | readonly | PluginType | Type of the plugin, defaults to standard. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.optionalplugins.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.optionalplugins.md
index 0fc42048be90c..4fc12ec34a8ca 100644
--- a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.optionalplugins.md
+++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.optionalplugins.md
@@ -6,7 +6,7 @@
An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly.
-Signature:
+**Signature:**
```typescript
readonly optionalPlugins: readonly PluginName[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md
index 6d54adb5236ea..e07068d16f68d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md
+++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md
@@ -6,7 +6,7 @@
List of plugin ids that this plugin's UI code imports modules from that are not in `requiredPlugins`.
-Signature:
+**Signature:**
```typescript
readonly requiredBundles: readonly PluginName[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredplugins.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredplugins.md
index b039891904669..3eda7a9566231 100644
--- a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredplugins.md
+++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredplugins.md
@@ -6,7 +6,7 @@
An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly.
-Signature:
+**Signature:**
```typescript
readonly requiredPlugins: readonly PluginName[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md
index 0a33be0d63f5c..a2ff590668881 100644
--- a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md
+++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md
@@ -6,7 +6,7 @@
Type of the plugin, defaults to `standard`.
-Signature:
+**Signature:**
```typescript
readonly type: PluginType;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md
index 279262aa6a5ec..e8d317249ccb4 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md
@@ -6,7 +6,7 @@
Client used to query the elasticsearch cluster.
-Signature:
+**Signature:**
```typescript
export declare type ElasticsearchClient = Omitmaster) client will be connecting to. |
-| [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) | | ElasticsearchConfigType\['customHeaders'\] | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by requestHeadersWhitelist configuration. |
-| [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) | | Duration | The interval between health check requests Kibana sends to the Elasticsearch. |
-| [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) | | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
-| [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) | | boolean | Whether to allow kibana to connect to a non-compatible elasticsearch node. |
-| [password?](./kibana-plugin-core-server.elasticsearchconfig.password.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. |
-| [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) | | Duration | Timeout after which PING HTTP request will be aborted and retried. |
-| [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) | | string\[\] | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. |
-| [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) | | Duration | Timeout after which HTTP request will be aborted and retried. |
-| [serviceAccountToken?](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) | | string | (Optional) If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions.This is an alternative to specifying a username and password. |
-| [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) | | Duration | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. |
-| [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) | | false \| Duration | Interval to perform a sniff operation and make sure the list of nodes is complete. If false then sniffing is disabled. |
-| [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) | | boolean | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. |
-| [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) | | boolean | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. |
-| [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) | | Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' \| 'keystore' \| 'truststore'>> & { certificateAuthorities?: string\[\]; } | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full. |
-| [username?](./kibana-plugin-core-server.elasticsearchconfig.username.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. |
+| [apiVersion](./kibana-plugin-core-server.elasticsearchconfig.apiversion.md) | readonly | string | Version of the Elasticsearch (6.7, 7.1 or master) client will be connecting to. |
+| [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) | readonly | ElasticsearchConfigType\['customHeaders'\] | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by requestHeadersWhitelist configuration. |
+| [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) | readonly | Duration | The interval between health check requests Kibana sends to the Elasticsearch. |
+| [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) | readonly | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
+| [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) | readonly | boolean | Whether to allow kibana to connect to a non-compatible elasticsearch node. |
+| [password?](./kibana-plugin-core-server.elasticsearchconfig.password.md) | readonly | string | _(Optional)_ If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. |
+| [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) | readonly | Duration | Timeout after which PING HTTP request will be aborted and retried. |
+| [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) | readonly | string\[\] | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. |
+| [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) | readonly | Duration | Timeout after which HTTP request will be aborted and retried. |
+| [serviceAccountToken?](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) | readonly | string | _(Optional)_ If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions.
This is an alternative to specifying a username and password.
| +| [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) |readonly | Duration | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. |
+| [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) | readonly | false \| Duration | Interval to perform a sniff operation and make sure the list of nodes is complete. If false then sniffing is disabled. |
+| [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) | readonly | boolean | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. |
+| [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) | readonly | boolean | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. |
+| [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) | readonly | Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' \| 'keystore' \| 'truststore'>> & { certificateAuthorities?: string\[\]; } | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full. |
+| [username?](./kibana-plugin-core-server.elasticsearchconfig.username.md) | readonly | string | _(Optional)_ If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md
index 2f927b5bc7c76..e2f5b6ebf043d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md
@@ -6,7 +6,7 @@
If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions.
-Signature:
+**Signature:**
```typescript
readonly password?: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md
index 07e37974219de..5d20379bfce09 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md
@@ -6,7 +6,7 @@
Timeout after which PING HTTP request will be aborted and retried.
-Signature:
+**Signature:**
```typescript
readonly pingTimeout: Duration;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md
index c19dcd3896366..8205ec383495a 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md
@@ -6,7 +6,7 @@
List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent.
-Signature:
+**Signature:**
```typescript
readonly requestHeadersWhitelist: string[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md
index f43cfc754b1f6..29cd896307636 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md
@@ -6,7 +6,7 @@
Timeout after which HTTP request will be aborted and retried.
-Signature:
+**Signature:**
```typescript
readonly requestTimeout: Duration;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md
index 5934e83de17a4..a23db69863d22 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md
@@ -8,7 +8,7 @@ If Elasticsearch security features are enabled, this setting provides the servic
This is an alternative to specifying a username and password.
-Signature:
+**Signature:**
```typescript
readonly serviceAccountToken?: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md
index c29f00a074e3f..2e0a997a67a97 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md
@@ -6,7 +6,7 @@
Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable.
-Signature:
+**Signature:**
```typescript
readonly shardTimeout: Duration;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md
index 19f6968b13863..9edd4cb4a9993 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md
@@ -6,7 +6,7 @@
Interval to perform a sniff operation and make sure the list of nodes is complete. If `false` then sniffing is disabled.
-Signature:
+**Signature:**
```typescript
readonly sniffInterval: false | Duration;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md
index a632b446a55fd..ba4b6f469b6d2 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md
@@ -6,7 +6,7 @@
Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies.
-Signature:
+**Signature:**
```typescript
readonly sniffOnConnectionFault: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md
index 09f3431c71880..392c6f18cb8bb 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md
@@ -6,7 +6,7 @@
Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated.
-Signature:
+**Signature:**
```typescript
readonly sniffOnStart: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md
index f88fc57339475..4807a1c37cc3e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md
@@ -6,7 +6,7 @@
Set of settings configure SSL connection between Kibana and Elasticsearch that are required when `xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`.
-Signature:
+**Signature:**
```typescript
readonly ssl: Pickusername, password or serviceAccountToken). |
-| [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [credentialsSpecified](./kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md) | readonly | boolean | Indicates whether Elasticsearch configuration includes credentials (username, password or serviceAccountToken). |
+| [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) | readonly | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md
index c4284248ea894..7940a303b550e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md
@@ -6,7 +6,7 @@
A limited set of Elasticsearch configuration entries.
-Signature:
+**Signature:**
```typescript
readonly config: Readonlyreadonly | Readonly<ElasticsearchConfigPreboot> | A limited set of Elasticsearch configuration entries. |
+| [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) | readonly | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md
index bcc2f474fa483..02dee1440410e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md
@@ -9,7 +9,7 @@
> Use [ElasticsearchServiceStart.legacy](./kibana-plugin-core-server.elasticsearchservicestart.legacy.md) instead.
>
-Signature:
+**Signature:**
```typescript
legacy: {
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md
index d18620992075d..5e139b84b0d8e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md
@@ -5,7 +5,7 @@
## ElasticsearchServiceSetup interface
-Signature:
+**Signature:**
```typescript
export interface ElasticsearchServiceSetup
@@ -13,7 +13,7 @@ export interface ElasticsearchServiceSetup
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) | { readonly config$: Observable<ElasticsearchConfig>; } | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) | | { readonly config$: Observable<ElasticsearchConfig>; } | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md
index 59f302170c53a..7871fca27cbbf 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md
@@ -6,7 +6,7 @@
A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md)
-Signature:
+**Signature:**
```typescript
readonly client: IClusterClient;
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md
index 26930c6f02b32..6d7df6bdd4dd6 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md
@@ -6,7 +6,7 @@
Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md).
-Signature:
+**Signature:**
```typescript
readonly createClient: (type: string, clientConfig?: Partialreadonly | IClusterClient | A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) |
+| [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | readonly | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). |
+| [legacy](./kibana-plugin-core-server.elasticsearchservicestart.legacy.md) | | { readonly config$: Observable<ElasticsearchConfig>; } | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md
index f8a45fe9a5a9c..072a0b3f58d2f 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md
@@ -4,7 +4,7 @@
## ElasticsearchStatusMeta.incompatibleNodes property
-Signature:
+**Signature:**
```typescript
incompatibleNodes: NodesVersionCompatibility['incompatibleNodes'];
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md
index 82748932c2102..f4cac3cfe617f 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md
@@ -5,7 +5,7 @@
## ElasticsearchStatusMeta interface
-Signature:
+**Signature:**
```typescript
export interface ElasticsearchStatusMeta
@@ -13,9 +13,9 @@ export interface ElasticsearchStatusMeta
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) | NodesVersionCompatibility\['incompatibleNodes'\] | |
-| [nodesInfoRequestError?](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) | NodesVersionCompatibility\['nodesInfoRequestError'\] | (Optional) |
-| [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) | NodesVersionCompatibility\['warningNodes'\] | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) | | NodesVersionCompatibility\['incompatibleNodes'\] | |
+| [nodesInfoRequestError?](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) | | NodesVersionCompatibility\['nodesInfoRequestError'\] | _(Optional)_ |
+| [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) | | NodesVersionCompatibility\['warningNodes'\] | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md
index 1b46078a1a453..cdb7426b1f9a1 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md
@@ -4,7 +4,7 @@
## ElasticsearchStatusMeta.nodesInfoRequestError property
-Signature:
+**Signature:**
```typescript
nodesInfoRequestError?: NodesVersionCompatibility['nodesInfoRequestError'];
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md
index 7374ccd9e7fa8..2f4b8f15dff0d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md
+++ b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md
@@ -4,7 +4,7 @@
## ElasticsearchStatusMeta.warningNodes property
-Signature:
+**Signature:**
```typescript
warningNodes: NodesVersionCompatibility['warningNodes'];
diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md
index 102e0c8f64b5a..f39986dffcf4b 100644
--- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md
+++ b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md
@@ -6,7 +6,7 @@
HTTP message to send to the client
-Signature:
+**Signature:**
```typescript
body?: ResponseError;
diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md
index bbd91156347b5..702e658247a75 100644
--- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md
+++ b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md
@@ -6,7 +6,7 @@
HTTP Headers with additional information about response
-Signature:
+**Signature:**
```typescript
headers?: ResponseHeaders;
diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md
index 3a037e71ac1e2..14baac7b1affb 100644
--- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md
+++ b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md
@@ -6,7 +6,7 @@
HTTP response parameters
-Signature:
+**Signature:**
```typescript
export interface ErrorHttpResponseOptions
@@ -14,8 +14,8 @@ export interface ErrorHttpResponseOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [body?](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) | ResponseError | (Optional) HTTP message to send to the client |
-| [headers?](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [body?](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) | | ResponseError | _(Optional)_ HTTP message to send to the client |
+| [headers?](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) | | ResponseHeaders | _(Optional)_ HTTP Headers with additional information about response |
diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md
index ae9df8b406be6..ef8d554b6d848 100644
--- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md
+++ b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md
@@ -6,7 +6,7 @@
Creating a new instance from EventLoopDelaysMonitor will automatically start tracking event loop delays.
-Signature:
+**Signature:**
```typescript
constructor();
diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md
index ff9c57787f71d..7289b61ca32f5 100644
--- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md
+++ b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md
@@ -8,12 +8,12 @@ Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLo
Returns metrics in milliseconds.
-Signature:
+**Signature:**
```typescript
collect(): IntervalHistogram;
```
-Returns:
+**Returns:**
IntervalHistogram
diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md
index e5d35547d3bdb..0dce6bd540fe2 100644
--- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md
+++ b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md
@@ -4,7 +4,7 @@
## EventLoopDelaysMonitor class
-Signature:
+**Signature:**
```typescript
export declare class EventLoopDelaysMonitor
@@ -20,7 +20,7 @@ export declare class EventLoopDelaysMonitor
| Method | Modifiers | Description |
| --- | --- | --- |
-| [collect()](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) | | Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time reset was called or this EventLoopDelaysMonitor instance was created.Returns metrics in milliseconds. |
+| [collect()](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) | | Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time reset was called or this EventLoopDelaysMonitor instance was created.
Returns metrics in milliseconds.
| | [reset()](./kibana-plugin-core-server.eventloopdelaysmonitor.reset.md) | | Resets the collected histogram data. | | [stop()](./kibana-plugin-core-server.eventloopdelaysmonitor.stop.md) | | Disables updating the interval timer for collecting new data points. | diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md index a65cc7c99842d..8d08e701bff6e 100644 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md +++ b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md @@ -6,12 +6,12 @@ Resets the collected histogram data. -Signature: +**Signature:** ```typescript reset(): void; ``` -Returns: +**Returns:** void diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md index d63c963b384e6..e82b1e9997216 100644 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md +++ b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md @@ -6,12 +6,12 @@ Disables updating the interval timer for collecting new data points. -Signature: +**Signature:** ```typescript stop(): void; ``` -Returns: +**Returns:** void diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md index 24591648ad953..84efac1a2c8c8 100644 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md +++ b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md @@ -5,7 +5,7 @@ ## ExecutionContextSetup interface -Signature: +**Signature:** ```typescript export interface ExecutionContextSetup diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md index 2bfef6db2f907..dd6e72907fc76 100644 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md +++ b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md @@ -6,7 +6,7 @@ Keeps track of execution context while the passed function is executed. Data are carried over all async operations spawned by the passed function. The nested calls stack the registered context on top of each other. -Signature: +**Signature:** ```typescript withContextauth interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) |
-| [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) | IsAuthenticated | Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [get](./kibana-plugin-core-server.httpauth.get.md) | | GetAuthState | Gets authentication state for a request. Returned by auth interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) |
+| [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) | | IsAuthenticated | Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) |
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.md
index 0b1854d7cbcd9..18793c9ce25a9 100644
--- a/docs/development/core/server/kibana-plugin-core-server.httpresources.md
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresources.md
@@ -6,7 +6,7 @@
HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file.
-Signature:
+**Signature:**
```typescript
export interface HttpResources
@@ -14,7 +14,7 @@ export interface HttpResources
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [register](./kibana-plugin-core-server.httpresources.register.md) | <P, Q, B, Context extends RequestHandlerContext = RequestHandlerContext>(route: RouteConfig<P, Q, B, 'get'>, handler: HttpResourcesRequestHandler<P, Q, B, Context>) => void | To register a route handler executing passed function to form response. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [register](./kibana-plugin-core-server.httpresources.register.md) | | <P, Q, B, Context extends RequestHandlerContext = RequestHandlerContext>(route: RouteConfig<P, Q, B, 'get'>, handler: HttpResourcesRequestHandler<P, Q, B, Context>) => void | To register a route handler executing passed function to form response. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md
index ee9569aeb37b4..bd44662522106 100644
--- a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md
@@ -6,7 +6,7 @@
To register a route handler executing passed function to form response.
-Signature:
+**Signature:**
```typescript
register: = RequestHandlerreadonly | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user |
+| [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) | | (request: ScopeableRequest) => IScopedClusterClient | Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) |
diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md
index ac13b86295f6d..5aafe40e5130d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md
+++ b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md
@@ -6,7 +6,7 @@
Create a new handler function pre-wired to context for the plugin.
-Signature:
+**Signature:**
```typescript
createHandler(pluginOpaqueId: PluginOpaqueId, handler: RequestHandler): (...rest: HandlerParametersContent-Security-Policy header. |
-| [rules](./kibana-plugin-core-server.icspconfig.rules.md) | string\[\] | The CSP rules used for Kibana. |
-| [strict](./kibana-plugin-core-server.icspconfig.strict.md) | boolean | Specify whether browsers that do not support CSP should be able to use Kibana. Use true to block and false to allow. |
-| [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) | boolean | Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) | readonly | boolean | Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled \*and\* no custom rules have been defined, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. |
+| [header](./kibana-plugin-core-server.icspconfig.header.md) | readonly | string | The CSP rules in a formatted directives string for use in a Content-Security-Policy header. |
+| [rules](./kibana-plugin-core-server.icspconfig.rules.md) | readonly | string\[\] | The CSP rules used for Kibana. |
+| [strict](./kibana-plugin-core-server.icspconfig.strict.md) | readonly | boolean | Specify whether browsers that do not support CSP should be able to use Kibana. Use true to block and false to allow. |
+| [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) | readonly | boolean | Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.rules.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.rules.md
index 808eefc30b64c..f8e14f8db346e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.rules.md
+++ b/docs/development/core/server/kibana-plugin-core-server.icspconfig.rules.md
@@ -6,7 +6,7 @@
The CSP rules used for Kibana.
-Signature:
+**Signature:**
```typescript
readonly rules: string[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md
index d8ea8ec377831..b81b202a2aefa 100644
--- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md
+++ b/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md
@@ -6,7 +6,7 @@
Specify whether browsers that do not support CSP should be able to use Kibana. Use `true` to block and `false` to allow.
-Signature:
+**Signature:**
```typescript
readonly strict: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md
index 84286262bcbf2..6b8fb12e27fbd 100644
--- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md
+++ b/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md
@@ -6,7 +6,7 @@
Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance.
-Signature:
+**Signature:**
```typescript
readonly warnLegacyBrowsers: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md
index 5fa2e93cca75b..34158cba768d6 100644
--- a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md
+++ b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md
@@ -6,7 +6,7 @@
Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API.
-Signature:
+**Signature:**
```typescript
close: () => Promisereadonly | IExternalUrlPolicy\[\] | A set of policies describing which external urls are allowed. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md
index b5b6f07038076..b56d171bd11c7 100644
--- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md
+++ b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md
@@ -6,7 +6,7 @@
A set of policies describing which external urls are allowed.
-Signature:
+**Signature:**
```typescript
readonly policy: IExternalUrlPolicy[];
diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md
index 47d3dbf83f2b3..8d3f59006ed3b 100644
--- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md
+++ b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md
@@ -6,7 +6,7 @@
Indicates if this policy allows or denies access to the described destination.
-Signature:
+**Signature:**
```typescript
allow: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md
index a549f80509474..f3d736d21b5ec 100644
--- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md
+++ b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md
@@ -6,7 +6,7 @@
Optional host describing the external destination. May be combined with `protocol`.
-Signature:
+**Signature:**
```typescript
host?: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md
index 45f7798eaf336..cadf4c684c511 100644
--- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md
+++ b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md
@@ -6,7 +6,7 @@
A policy describing whether access to an external destination is allowed.
-Signature:
+**Signature:**
```typescript
export interface IExternalUrlPolicy
@@ -14,9 +14,9 @@ export interface IExternalUrlPolicy
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. |
-| [host?](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined with protocol. |
-| [protocol?](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | | boolean | Indicates if this policy allows or denies access to the described destination. |
+| [host?](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | | string | _(Optional)_ Optional host describing the external destination. May be combined with protocol. |
+| [protocol?](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | | string | _(Optional)_ Optional protocol describing the external destination. May be combined with host. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md
index 86f6e6164de4e..9dd91aa79ebee 100644
--- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md
+++ b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md
@@ -6,7 +6,7 @@
Optional protocol describing the external destination. May be combined with `host`.
-Signature:
+**Signature:**
```typescript
protocol?: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md
index c71f5360834e8..8b4ca066ab187 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md
@@ -6,7 +6,7 @@
A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution
-Signature:
+**Signature:**
```typescript
export interface IKibanaResponsereadonly | HttpResponseOptions | |
+| [payload?](./kibana-plugin-core-server.ikibanaresponse.payload.md) | readonly | T | _(Optional)_ |
+| [status](./kibana-plugin-core-server.ikibanaresponse.status.md) | readonly | number | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md
index a91224a11282d..191a3ad14c344 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md
@@ -4,7 +4,7 @@
## IKibanaResponse.options property
-Signature:
+**Signature:**
```typescript
readonly options: HttpResponseOptions;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md
index 2475402bfb9fc..16f959cd830d1 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md
@@ -4,7 +4,7 @@
## IKibanaResponse.payload property
-Signature:
+**Signature:**
```typescript
readonly payload?: T;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md
index 2d7494d0e22b5..d5a092db19c62 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md
@@ -4,7 +4,7 @@
## IKibanaResponse.status property
-Signature:
+**Signature:**
```typescript
readonly status: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md
index 930179acf399a..daa15621f6bf1 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md
@@ -6,7 +6,7 @@
The reason why the peer's certificate has not been verified. This property becomes available only when `authorized` is `false`.
-Signature:
+**Signature:**
```typescript
readonly authorizationError?: Error;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md
index 5ead5a8556c92..651f87e13d496 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md
@@ -6,7 +6,7 @@
Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is `undefined`.
-Signature:
+**Signature:**
```typescript
readonly authorized?: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md
index 9f0dce061bcfc..86c7dbea4d91e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md
@@ -4,7 +4,7 @@
## IKibanaSocket.getPeerCertificate() method
-Signature:
+**Signature:**
```typescript
getPeerCertificate(detailed: true): DetailedPeerCertificate | null;
@@ -16,7 +16,7 @@ getPeerCertificate(detailed: true): DetailedPeerCertificate | null;
| --- | --- | --- |
| detailed | true | |
-Returns:
+**Returns:**
DetailedPeerCertificate \| null
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md
index 363fce50251d8..3b6a793de609c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md
@@ -4,7 +4,7 @@
## IKibanaSocket.getPeerCertificate() method
-Signature:
+**Signature:**
```typescript
getPeerCertificate(detailed: false): PeerCertificate | null;
@@ -16,7 +16,7 @@ getPeerCertificate(detailed: false): PeerCertificate | null;
| --- | --- | --- |
| detailed | false | |
-Returns:
+**Returns:**
PeerCertificate \| null
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md
index 24b11b6966000..d8b5f0b890dbd 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md
@@ -6,7 +6,7 @@
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.
-Signature:
+**Signature:**
```typescript
getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null;
@@ -16,9 +16,9 @@ getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificat
| Parameter | Type | Description |
| --- | --- | --- |
-| detailed | boolean | If true; the full chain with issuer property will be returned. |
+| detailed | boolean | _(Optional)_ If true; the full chain with issuer property will be returned. |
-Returns:
+**Returns:**
PeerCertificate \| DetailedPeerCertificate \| null
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md
index d605f2fd21bef..acb1844f810fc 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md
@@ -6,12 +6,12 @@
Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL\_get\_version.html for more information.
-Signature:
+**Signature:**
```typescript
getProtocol(): string | null;
```
-Returns:
+**Returns:**
string \| null
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md
index bc8f59df9d211..9bd2d6909101a 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md
@@ -6,7 +6,7 @@
A tiny abstraction for TCP socket.
-Signature:
+**Signature:**
```typescript
export interface IKibanaSocket
@@ -14,10 +14,10 @@ export interface IKibanaSocket
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [authorizationError?](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) | Error | (Optional) The reason why the peer's certificate has not been verified. This property becomes available only when authorized is false. |
-| [authorized?](./kibana-plugin-core-server.ikibanasocket.authorized.md) | boolean | (Optional) Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is undefined. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [authorizationError?](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) | readonly | Error | _(Optional)_ The reason why the peer's certificate has not been verified. This property becomes available only when authorized is false. |
+| [authorized?](./kibana-plugin-core-server.ikibanasocket.authorized.md) | readonly | boolean | _(Optional)_ Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is undefined. |
## Methods
diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md
index b4addde9b3179..7b749d7b3924c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md
+++ b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md
@@ -6,7 +6,7 @@
Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3.
-Signature:
+**Signature:**
```typescript
renegotiate(options: {
@@ -21,7 +21,7 @@ renegotiate(options: {
| --- | --- | --- |
| options | { rejectUnauthorized?: boolean; requestCert?: boolean; } | The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). |
-Returns:
+**Returns:**
Promise<void>
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md
index 664bdb8f24d7b..43ce5cc95b0b7 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md
@@ -4,7 +4,7 @@
## IntervalHistogram.exceeds property
-Signature:
+**Signature:**
```typescript
exceeds: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md
index 00fa8dcb84430..686d45a2bfa31 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md
@@ -4,7 +4,7 @@
## IntervalHistogram.fromTimestamp property
-Signature:
+**Signature:**
```typescript
fromTimestamp: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md
index 58e75fc2ba437..79aab3f51ed58 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md
@@ -4,7 +4,7 @@
## IntervalHistogram.lastUpdatedAt property
-Signature:
+**Signature:**
```typescript
lastUpdatedAt: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md
index 14d7fe6b68c4b..f4cff8bb26252 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md
@@ -4,7 +4,7 @@
## IntervalHistogram.max property
-Signature:
+**Signature:**
```typescript
max: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md
index 56a87a1577e98..ea1ac3c07d27e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md
@@ -6,7 +6,7 @@
an IntervalHistogram object that samples and reports the event loop delay over time. The delays will be reported in milliseconds.
-Signature:
+**Signature:**
```typescript
export interface IntervalHistogram
@@ -14,14 +14,14 @@ export interface IntervalHistogram
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) | number | |
-| [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) | string | |
-| [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) | string | |
-| [max](./kibana-plugin-core-server.intervalhistogram.max.md) | number | |
-| [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) | number | |
-| [min](./kibana-plugin-core-server.intervalhistogram.min.md) | number | |
-| [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) | { 50: number; 75: number; 95: number; 99: number; } | |
-| [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) | number | |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) | | number | |
+| [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) | | string | |
+| [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) | | string | |
+| [max](./kibana-plugin-core-server.intervalhistogram.max.md) | | number | |
+| [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) | | number | |
+| [min](./kibana-plugin-core-server.intervalhistogram.min.md) | | number | |
+| [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) | | { 50: number; 75: number; 95: number; 99: number; } | |
+| [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) | | number | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md
index e6794bfa5fe52..f8e28509782cb 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md
@@ -4,7 +4,7 @@
## IntervalHistogram.mean property
-Signature:
+**Signature:**
```typescript
mean: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md
index d0eb929601f18..230544ce82f6b 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md
@@ -4,7 +4,7 @@
## IntervalHistogram.min property
-Signature:
+**Signature:**
```typescript
min: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md
index b0adc9531c0b1..4e40eaec2153f 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md
@@ -4,7 +4,7 @@
## IntervalHistogram.percentiles property
-Signature:
+**Signature:**
```typescript
percentiles: {
diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md
index bca5ab56cb237..f2120d7cdc9fe 100644
--- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md
+++ b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md
@@ -4,7 +4,7 @@
## IntervalHistogram.stddev property
-Signature:
+**Signature:**
```typescript
stddev: number;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md
index dc2af11f9f9d3..316b8812a0738 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md
@@ -6,7 +6,7 @@
Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. `false` by default.
-Signature:
+**Signature:**
```typescript
isAnonymousPage?: boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md
index 84539a6aa73ca..800f94ce47250 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md
@@ -5,7 +5,7 @@
## IRenderOptions interface
-Signature:
+**Signature:**
```typescript
export interface IRenderOptions
@@ -13,7 +13,7 @@ export interface IRenderOptions
## Properties
-| Property | Type | Description |
-| --- | --- | --- |
-| [isAnonymousPage?](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) | boolean | (Optional) Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. false by default. |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [isAnonymousPage?](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) | | boolean | _(Optional)_ Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. false by default. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md b/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md
index a7b6dd5bc294e..3c30f768cdb15 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md
@@ -6,7 +6,7 @@
Register a route handler for `DELETE` request.
-Signature:
+**Signature:**
```typescript
delete: RouteRegistrar<'delete', Context>;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md b/docs/development/core/server/kibana-plugin-core-server.irouter.get.md
index 7db694b38da47..b5bbe9ee9f70c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.get.md
@@ -6,7 +6,7 @@
Register a route handler for `GET` request.
-Signature:
+**Signature:**
```typescript
get: RouteRegistrar<'get', Context>;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
index 35d109975c83a..a64a3802e9e18 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
@@ -6,7 +6,7 @@
Wrap a router handler to catch and converts legacy boom errors to proper custom errors.
-Signature:
+**Signature:**
```typescript
handleLegacyErrors: RequestHandlerWrapper;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.md b/docs/development/core/server/kibana-plugin-core-server.irouter.md
index a751ea399c5a9..6569ad910e2e8 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.md
@@ -6,7 +6,7 @@
Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations.
-Signature:
+**Signature:**
```typescript
export interface IRouterGET request. |
-| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | RequestHandlerWrapper | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. |
-| [patch](./kibana-plugin-core-server.irouter.patch.md) | RouteRegistrar<'patch', Context> | Register a route handler for PATCH request. |
-| [post](./kibana-plugin-core-server.irouter.post.md) | RouteRegistrar<'post', Context> | Register a route handler for POST request. |
-| [put](./kibana-plugin-core-server.irouter.put.md) | RouteRegistrar<'put', Context> | Register a route handler for PUT request. |
-| [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) | string | Resulted path |
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [delete](./kibana-plugin-core-server.irouter.delete.md) | | RouteRegistrar<'delete', Context> | Register a route handler for DELETE request. |
+| [get](./kibana-plugin-core-server.irouter.get.md) | | RouteRegistrar<'get', Context> | Register a route handler for GET request. |
+| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | | RequestHandlerWrapper | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. |
+| [patch](./kibana-plugin-core-server.irouter.patch.md) | | RouteRegistrar<'patch', Context> | Register a route handler for PATCH request. |
+| [post](./kibana-plugin-core-server.irouter.post.md) | | RouteRegistrar<'post', Context> | Register a route handler for POST request. |
+| [put](./kibana-plugin-core-server.irouter.put.md) | | RouteRegistrar<'put', Context> | Register a route handler for PUT request. |
+| [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) | | string | Resulted path |
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md b/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md
index b353079630ecb..3fe357bfebcd8 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md
@@ -6,7 +6,7 @@
Register a route handler for `PATCH` request.
-Signature:
+**Signature:**
```typescript
patch: RouteRegistrar<'patch', Context>;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md b/docs/development/core/server/kibana-plugin-core-server.irouter.post.md
index 94c703ad6f339..4053c722a1600 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.post.md
@@ -6,7 +6,7 @@
Register a route handler for `POST` request.
-Signature:
+**Signature:**
```typescript
post: RouteRegistrar<'post', Context>;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md b/docs/development/core/server/kibana-plugin-core-server.irouter.put.md
index 702ff3ff61bb6..9bb0bda26a50d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.put.md
@@ -6,7 +6,7 @@
Register a route handler for `PUT` request.
-Signature:
+**Signature:**
```typescript
put: RouteRegistrar<'put', Context>;
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md b/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md
index c326e33b01f1f..74d9d0c0c0a8f 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md
@@ -6,7 +6,7 @@
Resulted path
-Signature:
+**Signature:**
```typescript
routerPath: string;
diff --git a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md b/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md
index 0c2d7fab8b579..8288bdb01f7c0 100644
--- a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md
+++ b/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md
@@ -6,7 +6,7 @@
Returns authentication status for a request.
-Signature:
+**Signature:**
```typescript
export declare type IsAuthenticated = (request: KibanaRequest) => boolean;
diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md
index 5c7385ea663d3..8b1b14af4ff36 100644
--- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md
+++ b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md
@@ -5,7 +5,7 @@
## ISavedObjectsExporter type
-Signature:
+**Signature:**
```typescript
export declare type ISavedObjectsExporter = PublicMethodsOf