Edit the upgrade transform API

elastic · Dec 17, 2024 · 079066f · 079066f
1 parent e2eb9af
commit 079066f
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 11 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git 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