diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d47bc64419..c5a1da7a69 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11458,7 +11458,8 @@ "tags": [ "migration" ], - "summary": "This API cancels a migration reindex attempt for a data stream or index", + "summary": "Cancel a migration reindex operation", + "description": "Cancel a migration reindex attempt for a data stream or index.", "operationId": "indices-cancel-migrate-reindex", "parameters": [ { @@ -12290,8 +12291,8 @@ "tags": [ "migration" ], - "summary": "This API creates a destination from a source index", - "description": "It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.", + "summary": "Create an index from a source index", + "description": "Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", "operationId": "indices-create-from", "parameters": [ { @@ -12315,8 +12316,8 @@ "tags": [ "migration" ], - "summary": "This API creates a destination from a source index", - "description": "It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.", + "summary": "Create an index from a source index", + "description": "Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", "operationId": "indices-create-from-1", "parameters": [ { @@ -14218,13 +14219,14 @@ "tags": [ "migration" ], - "summary": "This API returns the status of a migration reindex attempt for a data stream or index", + "summary": "Get the migration reindexing status", + "description": "Get the status of a migration reindex attempt for a data stream or index.", "operationId": "indices-get-migrate-reindex-status", "parameters": [ { "in": "path", "name": "index", - "description": "The index or data stream name", + "description": "The index or data stream name.", "required": true, "deprecated": false, "schema": { @@ -14581,8 +14583,8 @@ "tags": [ "migration" ], - "summary": "\"This API reindexes all legacy backing indices for a data stream", - "description": "It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task", + "summary": "Reindex legacy backing indices", + "description": "Reindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", "operationId": "indices-migrate-reindex", "requestBody": { "content": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 0a3b6863a5..477ce33a1a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6279,7 +6279,7 @@ "stability": "experimental" } }, - "description": "This API cancels a migration reindex attempt for a data stream or index", + "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", "docId": "migrate", "docTag": "migration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-data-stream.html", @@ -6529,7 +6529,7 @@ "stability": "experimental" } }, - "description": "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.", + "description": "Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", "docId": "migrate", "docTag": "migration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-data-stream.html", @@ -7608,7 +7608,7 @@ "stability": "experimental" } }, - "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", "docId": "migrate", "docTag": "migration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-data-stream.html", @@ -7746,7 +7746,7 @@ "stability": "experimental" } }, - "description": "\"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", + "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", "docId": "migrate", "docTag": "migration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-data-stream.html", @@ -131900,7 +131900,7 @@ "body": { "kind": "no_body" }, - "description": "This API cancels a migration reindex attempt for a data stream or index", + "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", "inherits": { "type": { "name": "RequestBase", @@ -131926,7 +131926,7 @@ } ], "query": [], - "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts#L23-L37" + "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts#L23-L38" }, { "kind": "response", @@ -132808,7 +132808,7 @@ } } ], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L45-L59" + "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L46-L60" }, { "kind": "request", @@ -132826,7 +132826,7 @@ } } }, - "description": "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.", + "description": "Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", "inherits": { "type": { "name": "RequestBase", @@ -132864,7 +132864,7 @@ } ], "query": [], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L25-L43" + "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L25-L44" }, { "kind": "response", @@ -136580,7 +136580,7 @@ "body": { "kind": "no_body" }, - "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", "inherits": { "type": { "name": "RequestBase", @@ -136593,7 +136593,7 @@ }, "path": [ { - "description": "The index or data stream name", + "description": "The index or data stream name.", "name": "index", "required": true, "type": { @@ -136606,7 +136606,7 @@ } ], "query": [], - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts#L23-L37" + "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts#L23-L38" }, { "kind": "response", @@ -137127,7 +137127,7 @@ } } ], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L36-L45" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L39-L48" }, { "kind": "enum", @@ -137140,7 +137140,7 @@ "name": "ModeEnum", "namespace": "indices.migrate_reindex" }, - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L51-L53" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L54-L56" }, { "kind": "request", @@ -137158,7 +137158,7 @@ } } }, - "description": "\"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", + "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", "inherits": { "type": { "name": "RequestBase", @@ -137171,7 +137171,7 @@ }, "path": [], "query": [], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L23-L34" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L23-L37" }, { "kind": "response", @@ -137210,7 +137210,7 @@ } } ], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L47-L49" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L50-L52" }, { "kind": "request", diff --git a/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts b/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts index a10251e578..8f8513b81f 100644 --- 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 index 1270e4fed7..ed3951102a 100644 --- 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 index 50ffca9646..0f4eec021c 100644 --- 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 index 7a711ab7af..2eb69556ad 100644 --- 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