Skip to content

Commit 0b9942c

Browse files
lcawlgithub-actions[bot]
authored andcommitted
[DOCS] Edit migration summaries (#3298)
(cherry picked from commit a2e56ab)
1 parent 131b49b commit 0b9942c

File tree

5 files changed

+48
-13
lines changed

5 files changed

+48
-13
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 20 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/migration/deprecations/DeprecationInfoRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { IndexName } from '@_types/common'
2222

2323
/**
24+
* Get deprecation information.
25+
* Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
26+
*
27+
* TIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
2428
* @rest_spec_name migration.deprecations
2529
* @availability stack since=6.1.0 stability=stable
30+
* @cluster_privileges manage
2631
*/
2732
export interface Request extends RequestBase {
2833
path_parts: {

specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get feature migration information.
24+
* Version upgrades sometimes require changes to how features store configuration information and data in system indices.
25+
* Check which features need to be migrated and the status of any migrations that are in progress.
26+
*
27+
* TIP: This API is designed for indirect use by the Upgrade Assistant.
28+
* We strongly recommend you use the Upgrade Assistant.
2329
* @rest_spec_name migration.get_feature_upgrade_status
2430
* @availability stack since=7.16.0 stability=stable
2531
* @index_privileges manage
32+
* @cluster_privileges manage
2633
*/
2734
export interface Request extends RequestBase {}

specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Start the feature migration.
24+
* Version upgrades sometimes require changes to how features store configuration information and data in system indices.
25+
* This API starts the automatic migration process.
26+
*
27+
* Some functionality might be temporarily unavailable during the migration process.
28+
*
29+
* TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
2330
* @rest_spec_name migration.post_feature_upgrade
2431
* @availability stack since=7.16.0 stability=stable
2532
* @index_privileges manage
33+
* @cluster_privileges manage
2634
*/
2735
export interface Request extends RequestBase {}

0 commit comments

Comments
 (0)