Skip to content

Commit e908944

Browse files
committed
update docs
1 parent 5ff2eec commit e908944

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ correctiveActions: {
1515
[key: string]: any;
1616
};
1717
};
18-
manualSteps?: string[];
18+
manualSteps: string[];
1919
};
2020
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export interface DeprecationsDetails
1414

1515
| Property | Type | Description |
1616
| --- | --- | --- |
17-
| [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> | |
17+
| [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> | |
1818
| [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. |
1919
| [documentationUrl](./kibana-plugin-core-server.deprecationsdetails.documentationurl.md) | <code>string</code> | |
2020
| [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. |

src/core/server/server.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -872,7 +872,7 @@ export interface DeprecationsDetails {
872872
[key: string]: any;
873873
};
874874
};
875-
manualSteps?: string[];
875+
manualSteps: string[];
876876
};
877877
deprecationType?: 'config' | 'feature';
878878
// (undocumented)

0 commit comments

Comments
 (0)