Updated docs

docs/development/core/server/kibana-plugin-server.deprecationsettings.doclinkskey.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) &gt; [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md)
+
+## DeprecationSettings.docLinksKey property
+
+<b>Signature:</b>
+
+```typescript
+docLinksKey: string;
+```

docs/development/core/server/kibana-plugin-server.deprecationsettings.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md)
+
+## DeprecationSettings interface
+
+UiSettings deprecation field options.
+
+<b>Signature:</b>
+
+```typescript
+export interface DeprecationSettings 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md) | <code>string</code> |  |
+|  [message](./kibana-plugin-server.deprecationsettings.message.md) | <code>string</code> |  |
+

docs/development/core/server/kibana-plugin-server.deprecationsettings.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) &gt; [message](./kibana-plugin-server.deprecationsettings.message.md)
+
+## DeprecationSettings.message property
+
+<b>Signature:</b>
+
+```typescript
+message: string;
+```

docs/development/core/server/kibana-plugin-server.md

@@ -56,6 +56,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md) |  |
 |  [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) |  |
 |  [DeprecationInfo](./kibana-plugin-server.deprecationinfo.md) |  |
+|  [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) | UiSettings deprecation field options. |
 |  [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
 |  [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) |  |
 |  [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) |  |

docs/development/core/server/kibana-plugin-server.uisettingsparams.deprecation.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) &gt; [deprecation](./kibana-plugin-server.uisettingsparams.deprecation.md)
+
+## UiSettingsParams.deprecation property
+
+optional deprecation information. Used to generate a deprecation warning.
+
+<b>Signature:</b>
+
+```typescript
+deprecation?: DeprecationSettings;
+```

docs/development/core/server/kibana-plugin-server.uisettingsparams.md

@@ -17,6 +17,7 @@ export interface UiSettingsParams
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [category](./kibana-plugin-server.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
+|  [deprecation](./kibana-plugin-server.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
 |  [description](./kibana-plugin-server.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
 |  [name](./kibana-plugin-server.uisettingsparams.name.md) | <code>string</code> | title in the UI |
 |  [optionLabels](./kibana-plugin-server.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |

src/core/server/index.ts

@@ -211,6 +211,7 @@ export {
 
 export {
   IUiSettingsClient,
+  DeprecationSettings,
   UiSettingsParams,
   UiSettingsType,
   UiSettingsServiceSetup,

src/core/server/server.api.md

@@ -635,6 +635,14 @@ export interface DeprecationInfo {
     url: string;
 }
 
+// @public
+export interface DeprecationSettings {
+    // (undocumented)
+    docLinksKey: string;
+    // (undocumented)
+    message: string;
+}
+
 // @public
 export interface DiscoveredPlugin {
     readonly configPath: ConfigPath;
@@ -1928,6 +1936,7 @@ export type SharedGlobalConfig = RecursiveReadonly_2<{
 // @public
 export interface UiSettingsParams {
     category?: string[];
+    deprecation?: DeprecationSettings;
     description?: string;
     name?: string;
     optionLabels?: Record<string, string>;

src/core/server/ui_settings/index.ts

@@ -26,6 +26,7 @@ export {
   UiSettingsServiceSetup,
   UiSettingsServiceStart,
   IUiSettingsClient,
+  DeprecationSettings,
   UiSettingsParams,
   InternalUiSettingsServiceSetup,
   InternalUiSettingsServiceStart,