From f404e23eb897cc4dc40b50aaa63a06305e9d92a1 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 12 Dec 2024 14:45:46 -0800 Subject: [PATCH] [DOCS] Edit migration summaries --- .../migration/deprecations/DeprecationInfoRequest.ts | 5 +++++ .../GetFeatureUpgradeStatusRequest.ts | 7 +++++++ .../post_feature_upgrade/PostFeatureUpgradeRequest.ts | 8 ++++++++ 3 files changed, 20 insertions(+) diff --git a/specification/migration/deprecations/DeprecationInfoRequest.ts b/specification/migration/deprecations/DeprecationInfoRequest.ts index c901dc6f29..a750d93280 100644 --- a/specification/migration/deprecations/DeprecationInfoRequest.ts +++ b/specification/migration/deprecations/DeprecationInfoRequest.ts @@ -21,8 +21,13 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** + * Get deprecation information. + * 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. + * + * TIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.deprecations * @availability stack since=6.1.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts index 54896f33b1..e953f6b4a5 100644 --- a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts @@ -20,8 +20,15 @@ import { RequestBase } from '@_types/Base' /** + * Get feature migration information. + * Version upgrades sometimes require changes to how features store configuration information and data in system indices. + * Check which features need to be migrated and the status of any migrations that are in progress. + * + * TIP: This API is designed for indirect use by the Upgrade Assistant. + * We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.get_feature_upgrade_status * @availability stack since=7.16.0 stability=stable * @index_privileges manage + * @cluster_privileges manage */ export interface Request extends RequestBase {} diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts index 30c6ff117e..822ecc610d 100644 --- a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts @@ -20,8 +20,16 @@ import { RequestBase } from '@_types/Base' /** + * Start the feature migration. + * Version upgrades sometimes require changes to how features store configuration information and data in system indices. + * This API starts the automatic migration process. + * + * Some functionality might be temporarily unavailable during the migration process. + * + * TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.post_feature_upgrade * @availability stack since=7.16.0 stability=stable * @index_privileges manage + * @cluster_privileges manage */ export interface Request extends RequestBase {}