From 99510720d0f760e916433519c4461a32d22b666b Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 16 Dec 2024 16:37:35 -0800 Subject: [PATCH] [DOCS] Edit migration summaries (#3298) (cherry picked from commit a2e56ab52e1e850d529e850111325b0413812491) --- output/openapi/elasticsearch-openapi.json | 12 +++++--- output/schema/schema.json | 29 +++++++++++++------ .../deprecations/DeprecationInfoRequest.ts | 5 ++++ .../GetFeatureUpgradeStatusRequest.ts | 7 +++++ .../PostFeatureUpgradeRequest.ts | 8 +++++ 5 files changed, 48 insertions(+), 13 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 0da92ddd44..6da7c6f092 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -16379,7 +16379,8 @@ "tags": [ "migration" ], - "summary": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version", + "summary": "Get deprecation information", + "description": "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.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-deprecations", "responses": { "200": { @@ -16394,7 +16395,8 @@ "tags": [ "migration" ], - "summary": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version", + "summary": "Get deprecation information", + "description": "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.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-deprecations-1", "parameters": [ { @@ -16414,7 +16416,8 @@ "tags": [ "migration" ], - "summary": "Find out whether system features need to be upgraded or not", + "summary": "Get feature migration information", + "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "operationId": "migration-get-feature-upgrade-status", "responses": { "200": { @@ -16449,7 +16452,8 @@ "tags": [ "migration" ], - "summary": "Begin upgrades for system features", + "summary": "Start the feature migration", + "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-post-feature-upgrade", "responses": { "200": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 7b6dee6672..e101ef127b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9550,9 +9550,14 @@ "stability": "stable" } }, - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "name": "migration.deprecations", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "migration.deprecations" @@ -9587,10 +9592,13 @@ "stability": "stable" } }, - "description": "Find out whether system features need to be upgraded or not", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.get_feature_upgrade_status", "privileges": { + "cluster": [ + "manage" + ], "index": [ "manage" ] @@ -9623,10 +9631,13 @@ "stability": "stable" } }, - "description": "Begin upgrades for system features", + "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.post_feature_upgrade", "privileges": { + "cluster": [ + "manage" + ], "index": [ "manage" ] @@ -149179,7 +149190,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149205,7 +149216,7 @@ } ], "query": [], - "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L32" + "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L37" }, { "kind": "response", @@ -149442,7 +149453,7 @@ "body": { "kind": "no_body" }, - "description": "Find out whether system features need to be upgraded or not", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149455,7 +149466,7 @@ }, "path": [], "query": [], - "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L27" + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L34" }, { "kind": "response", @@ -149524,7 +149535,7 @@ "body": { "kind": "no_body" }, - "description": "Begin upgrades for system features", + "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149537,7 +149548,7 @@ }, "path": [], "query": [], - "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L27" + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L35" }, { "kind": "response", 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 {}