[Core] create deprecations service

docs/development/core/public/kibana-plugin-core-public.coresetup.deprecations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [CoreSetup](./kibana-plugin-core-public.coresetup.md) &gt; [deprecations](./kibana-plugin-core-public.coresetup.deprecations.md)
+
+## CoreSetup.deprecations property
+
+[DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md)
+
+<b>Signature:</b>
+
+```typescript
+deprecations: DeprecationsServiceSetup;
+```

docs/development/core/public/kibana-plugin-core-public.coresetup.md

@@ -17,6 +17,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [application](./kibana-plugin-core-public.coresetup.application.md) | <code>ApplicationSetup</code> | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) |
+|  [deprecations](./kibana-plugin-core-public.coresetup.deprecations.md) | <code>DeprecationsServiceSetup</code> | [DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md) |
 |  [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) |
 |  [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) |
 |  [http](./kibana-plugin-core-public.coresetup.http.md) | <code>HttpSetup</code> | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |

docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [CoreStart](./kibana-plugin-core-public.corestart.md) &gt; [deprecations](./kibana-plugin-core-public.corestart.deprecations.md)
+
+## CoreStart.deprecations property
+
+[DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md)
+
+<b>Signature:</b>
+
+```typescript
+deprecations: DeprecationsServiceStart;
+```

docs/development/core/public/kibana-plugin-core-public.corestart.md

@@ -18,6 +18,7 @@ export interface CoreStart
 |  --- | --- | --- |
 |  [application](./kibana-plugin-core-public.corestart.application.md) | <code>ApplicationStart</code> | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) |
 |  [chrome](./kibana-plugin-core-public.corestart.chrome.md) | <code>ChromeStart</code> | [ChromeStart](./kibana-plugin-core-public.chromestart.md) |
+|  [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | <code>DeprecationsServiceStart</code> | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) |
 |  [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | <code>DocLinksStart</code> | [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) |
 |  [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | <code>FatalErrorsStart</code> | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) |
 |  [http](./kibana-plugin-core-public.corestart.http.md) | <code>HttpStart</code> | [HttpStart](./kibana-plugin-core-public.httpstart.md) |

docs/development/core/public/kibana-plugin-core-public.deprecationsservicesetup.getalldeprecations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md) &gt; [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicesetup.getalldeprecations.md)
+
+## DeprecationsServiceSetup.getAllDeprecations property
+
+Grabs deprecations for all plugins.
+
+<b>Signature:</b>
+
+```typescript
+getAllDeprecations: DeprecationsClient['getAllDeprecations'];
+```

docs/development/core/public/kibana-plugin-core-public.deprecationsservicesetup.getdeprecations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md) &gt; [getDeprecations](./kibana-plugin-core-public.deprecationsservicesetup.getdeprecations.md)
+
+## DeprecationsServiceSetup.getDeprecations property
+
+Grabs deprecations for a specific plugin.
+
+<b>Signature:</b>
+
+```typescript
+getDeprecations: DeprecationsClient['getDeprecations'];
+```

docs/development/core/public/kibana-plugin-core-public.deprecationsservicesetup.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md)
+
+## DeprecationsServiceSetup interface
+
+DeprecationsService provides methods to fetch plugin deprecation details from the Kibana server.
+
+<b>Signature:</b>
+
+```typescript
+export interface DeprecationsServiceSetup 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicesetup.getalldeprecations.md) | <code>DeprecationsClient['getAllDeprecations']</code> | Grabs deprecations for all plugins. |
+|  [getDeprecations](./kibana-plugin-core-public.deprecationsservicesetup.getdeprecations.md) | <code>DeprecationsClient['getDeprecations']</code> | Grabs deprecations for a specific plugin. |
+

docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md)
+
+## DeprecationsServiceStart type
+
+DeprecationsService provides methods to fetch plugin deprecation details from the Kibana server.
+
+<b>Signature:</b>
+
+```typescript
+export declare type DeprecationsServiceStart = DeprecationsServiceSetup;
+```

docs/development/core/public/kibana-plugin-core-public.getalldeprecationsconfig.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [GetAllDeprecationsConfig](./kibana-plugin-core-public.getalldeprecationsconfig.md)
+
+## GetAllDeprecationsConfig type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type GetAllDeprecationsConfig = GetDeprecationsConfig;
+```

docs/development/core/public/kibana-plugin-core-public.getdeprecationsconfig.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [GetDeprecationsConfig](./kibana-plugin-core-public.getdeprecationsconfig.md)
+
+## GetDeprecationsConfig interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface GetDeprecationsConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [skipCache](./kibana-plugin-core-public.getdeprecationsconfig.skipcache.md) | <code>boolean</code> | set true to fetch a fresh copy of the deprecations from the kibana server. |
+

docs/development/core/public/kibana-plugin-core-public.getdeprecationsconfig.skipcache.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [GetDeprecationsConfig](./kibana-plugin-core-public.getdeprecationsconfig.md) &gt; [skipCache](./kibana-plugin-core-public.getdeprecationsconfig.skipcache.md)
+
+## GetDeprecationsConfig.skipCache property
+
+set true to fetch a fresh copy of the deprecations from the kibana server.
+
+<b>Signature:</b>
+
+```typescript
+skipCache?: boolean;
+```

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

@@ -59,10 +59,12 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) |  |
 |  [CoreSetup](./kibana-plugin-core-public.coresetup.md) | Core services exposed to the <code>Plugin</code> setup lifecycle |
 |  [CoreStart](./kibana-plugin-core-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
+|  [DeprecationsServiceSetup](./kibana-plugin-core-public.deprecationsservicesetup.md) | DeprecationsService provides methods to fetch plugin deprecation details from the Kibana server. |
 |  [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) |  |
 |  [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. |
 |  [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
 |  [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
+|  [GetDeprecationsConfig](./kibana-plugin-core-public.getdeprecationsconfig.md) |  |
 |  [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) | All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md)<!-- -->. |
 |  [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) | Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included. |
 |  [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md) |  |
@@ -153,7 +155,9 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) |  |
 |  [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) |  |
 |  [ChromeNavLinkUpdateableFields](./kibana-plugin-core-public.chromenavlinkupdateablefields.md) |  |
+|  [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | DeprecationsService provides methods to fetch plugin deprecation details from the Kibana server. |
 |  [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
+|  [GetAllDeprecationsConfig](./kibana-plugin-core-public.getalldeprecationsconfig.md) |  |
 |  [HttpStart](./kibana-plugin-core-public.httpstart.md) | See [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |
 |  [IToasts](./kibana-plugin-core-public.itoasts.md) | Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-core-public.toastsapi.md)<!-- -->. |
 |  [MountPoint](./kibana-plugin-core-public.mountpoint.md) | A function that should mount DOM content inside the provided container element and return a handler to unmount it. |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreSetup](./kibana-plugin-core-server.coresetup.md) &gt; [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md)
+
+## CoreSetup.deprecations property
+
+[DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md)
+
+<b>Signature:</b>
+
+```typescript
+deprecations: DeprecationsServiceSetup;
+```

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

@@ -18,6 +18,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
 |  --- | --- | --- |
 |  [capabilities](./kibana-plugin-core-server.coresetup.capabilities.md) | <code>CapabilitiesSetup</code> | [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) |
 |  [context](./kibana-plugin-core-server.coresetup.context.md) | <code>ContextSetup</code> | [ContextSetup](./kibana-plugin-core-server.contextsetup.md) |
+|  [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md) | <code>DeprecationsServiceSetup</code> | [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) |
 |  [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) | <code>ElasticsearchServiceSetup</code> | [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) |
 |  [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) |
 |  [http](./kibana-plugin-core-server.coresetup.http.md) | <code>HttpServiceSetup &amp; {</code><br/><code>        resources: HttpResources;</code><br/><code>    }</code> | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) |

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) &gt; [correctiveActions](./kibana-plugin-core-server.deprecationsdetails.correctiveactions.md)
+
+## DeprecationsDetails.correctiveActions property
+
+<b>Signature:</b>
+
+```typescript
+correctiveActions: {
+        api?: {
+            path: string;
+            method: 'POST' | 'PUT';
+            body?: {
+                [key: string]: any;
+            };
+        };
+        manualSteps?: string[];
+    };
+```

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

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

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) &gt; [level](./kibana-plugin-core-server.deprecationsdetails.level.md)
+
+## DeprecationsDetails.level property
+
+<b>Signature:</b>
+
+```typescript
+level: 'warning' | 'critical';
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md)
+
+## DeprecationsDetails interface
+
+<b>Signature:</b>
+
+```typescript
+export interface DeprecationsDetails 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [correctiveActions](./kibana-plugin-core-server.deprecationsdetails.correctiveactions.md) | <code>{</code><br/><code>        api?: {</code><br/><code>            path: string;</code><br/><code>            method: 'POST' &#124; 'PUT';</code><br/><code>            body?: {</code><br/><code>                [key: string]: any;</code><br/><code>            };</code><br/><code>        };</code><br/><code>        manualSteps?: string[];</code><br/><code>    }</code> |  |
+|  [documentationUrl](./kibana-plugin-core-server.deprecationsdetails.documentationurl.md) | <code>string</code> |  |
+|  [level](./kibana-plugin-core-server.deprecationsdetails.level.md) | <code>'warning' &#124; 'critical'</code> |  |
+|  [message](./kibana-plugin-core-server.deprecationsdetails.message.md) | <code>string</code> |  |
+

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

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

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

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md)
+
+## DeprecationsServiceSetup interface
+
+The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version.
+
+<b>Signature:</b>
+
+```typescript
+export interface DeprecationsServiceSetup 
+```
+
+## Example
+
+
+```ts
+import { DeprecationsDetails, GetDeprecationsContext, CoreSetup } from 'src/core/server';
+
+const getDeprecations = async ({ esClient, savedObjectsClient }: GetDeprecationsContext): DeprecationsDetails[] => {
+  return [
+     {
+       message: string;
+       level: 'warning' | 'critical';
+       documentationUrl?: string;
+       correctiveActions: {
+         api?: {
+           path: string;
+           method: 'POST' | 'PUT';
+           body?: { [key: string]: any },
+         },
+         manualSteps?: string[];
+       }
+     }
+  ]
+}
+
+export class Plugin() {
+  setup: (core: CoreSetup) => {
+    core.deprecations.registerDeprecations({ getDeprecations });
+  }
+}
+
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [registerDeprecations](./kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md) | <code>DeprecationsRegistry['registerDeprecations']</code> |  |
+

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

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