Edit migration reindexing summaries (#3573) (#3588)

(cherry picked from commit a72afb8) Co-authored-by: Lisa Cawley <lcawley@elastic.co>
elastic · Jan 23, 2025 · f413af8 · f413af8
1 parent 4588bf5
commit f413af8
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 31 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/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts b/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts
@@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base'
 import { Indices } from '@_types/common'
 
 /**
- * This API cancels a migration reindex attempt for a data stream or index
+ * Cancel a migration reindex operation.
  *
+ * Cancel a migration reindex attempt for a data stream or index.
  * @rest_spec_name indices.cancel_migrate_reindex
  * @availability stack since=8.18.0 stability=experimental
  * @availability serverless stability=experimental visibility=private

diff --git a/specification/indices/create_from/MigrateCreateFromRequest.ts b/specification/indices/create_from/MigrateCreateFromRequest.ts
@@ -23,8 +23,9 @@ import { IndexName } from '@_types/common'
 import { TypeMapping } from '@_types/mapping/TypeMapping'
 
 /**
- * This API creates a destination from a source index. It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.
+ * Create an index from a source index.
  *
+ * Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
  * @rest_spec_name indices.create_from
  * @availability stack since=8.18.0 stability=experimental
  * @availability serverless stability=experimental visibility=private

diff --git a/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts b/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts
@@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base'
 import { Indices } from '@_types/common'
 
 /**
- * This API returns the status of a migration reindex attempt for a data stream or index
+ * Get the migration reindexing status.
  *
+ * Get the status of a migration reindex attempt for a data stream or index.
  * @rest_spec_name indices.get_migrate_reindex_status
  * @availability stack since=8.18.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
@@ -31,7 +32,7 @@ import { Indices } from '@_types/common'
  */
 export interface Request extends RequestBase {
   path_parts: {
-    /** The index or data stream name */
+    /** The index or data stream name. */
     index: Indices
   }
 }
diff --git a/specification/indices/migrate_reindex/MigrateReindexRequest.ts b/specification/indices/migrate_reindex/MigrateReindexRequest.ts
@@ -21,8 +21,11 @@ import { RequestBase } from '@_types/Base'
 import { IndexName } from '@_types/common'
 
 /**
- * "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task
+ * Reindex legacy backing indices.
  *
+ * Reindex all legacy backing indices for a data stream.
+ * This operation occurs in a persistent task.
+ * The persistent task ID is returned immediately and the reindexing work is completed in that task.
  * @rest_spec_name indices.migrate_reindex
  * @availability stack since=8.18.0 stability=experimental
  * @doc_id migrate