From 079066fb647363439129af7c9413105a72bb33d6 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 17 Dec 2024 11:57:29 -0800 Subject: [PATCH] Edit the upgrade transform API --- output/openapi/elasticsearch-openapi.json | 4 ++-- output/schema/schema.json | 6 +++--- .../UpgradeTransformsRequest.ts | 20 +++++++++++++------ 3 files changed, 19 insertions(+), 11 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 96ec20e55c..4333b9fc39 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -34989,8 +34989,8 @@ "tags": [ "transform" ], - "summary": "Upgrades all transforms", - "description": "This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "summary": "Upgrade all transforms", + "description": "Transforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "operationId": "transform-upgrade-transforms", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 7a46a6f84d..cda97c03d7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -20154,7 +20154,7 @@ "stability": "stable" } }, - "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", "name": "transform.upgrade_transforms", "privileges": { @@ -211748,7 +211748,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "inherits": { "type": { "name": "RequestBase", @@ -211788,7 +211788,7 @@ } } ], - "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L49" + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L57" }, { "kind": "response", diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts index d4908da900..552dbc7f48 100644 --- a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts +++ b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts @@ -21,12 +21,20 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * Upgrades all transforms. - * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - * also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - * affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - * Elasticsearch security features are enabled; the role used to read source data and write to the destination index - * remains unchanged. + * Upgrade all transforms. + * Transforms are compatible across minor versions and between supported major versions. + * However, over time, the format of transform configuration information may change. + * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + * It also cleans up the internal data structures that store the transform state and checkpoints. + * The upgrade does not affect the source and destination indices. + * The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + * + * If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + * Resolve the issue then re-run the process again. + * A summary is returned when the upgrade is finished. + * + * To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + * You may want to perform a recent cluster backup prior to the upgrade. * @rest_spec_name transform.upgrade_transforms * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private