Skip to content

Commit 41b96a1

Browse files
committed
update api changes documentation
1 parent 291dcd0 commit 41b96a1

File tree

5 files changed

+17
-4
lines changed

5 files changed

+17
-4
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) &gt; [deprecationType](./kibana-plugin-core-server.deprecationsdetails.deprecationtype.md)
4+
5+
## DeprecationsDetails.deprecationType property
6+
7+
(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.
8+
9+
Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
deprecationType?: 'config' | 'feature';
15+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ export interface DeprecationsDetails
1515
| Property | Type | Description |
1616
| --- | --- | --- |
1717
| [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> | |
18+
| [deprecationType](./kibana-plugin-core-server.deprecationsdetails.deprecationtype.md) | <code>'config' &#124; 'feature'</code> | (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. |
1819
| [documentationUrl](./kibana-plugin-core-server.deprecationsdetails.documentationurl.md) | <code>string</code> | |
1920
| [level](./kibana-plugin-core-server.deprecationsdetails.level.md) | <code>'warning' &#124; 'critical' &#124; 'fetch_error'</code> | 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. |
2021
| [message](./kibana-plugin-core-server.deprecationsdetails.message.md) | <code>string</code> | |

src/core/server/deprecations/deprecations_service.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ import { RegisterDeprecationsConfig } from './types';
1111
import { registerRoutes } from './routes';
1212

1313
import { CoreContext } from '../core_context';
14-
import { CoreUsageDataSetup } from '../core_usage_data';
15-
import { InternalElasticsearchServiceSetup } from '../elasticsearch';
1614
import { CoreService } from '../../types';
1715
import { InternalHttpServiceSetup } from '../http';
1816
import { Logger } from '../logging';

src/core/server/server.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,7 @@ export interface DeprecationsDetails {
874874
};
875875
manualSteps?: string[];
876876
};
877+
deprecationType?: 'config' | 'feature';
877878
// (undocumented)
878879
documentationUrl?: string;
879880
level: 'warning' | 'critical' | 'fetch_error';

src/core/server/server.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,6 @@ export class Server {
193193

194194
const deprecationsSetup = this.deprecations.setup({
195195
http: httpSetup,
196-
elasticsearch: elasticsearchServiceSetup,
197-
coreUsageData: coreUsageDataSetup,
198196
});
199197

200198
const coreSetup: InternalCoreSetup = {

0 commit comments

Comments
 (0)