From ea1c30ad9974554c8d917198fcf2295d3ce35459 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 22 Jan 2025 15:19:24 -0800 Subject: [PATCH 1/2] Edit migration reindexing summaries --- output/openapi/elasticsearch-openapi.json | 20 ++++++----- output/schema/schema.json | 34 +++++++++---------- .../MigrateCancelReindexRequest.ts | 3 +- .../create_from/MigrateCreateFromRequest.ts | 3 +- .../MigrateGetReindexStatusRequest.ts | 5 +-- .../migrate_reindex/MigrateReindexRequest.ts | 5 ++- 6 files changed, 39 insertions(+), 31 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5dda4e760c..bfb423adf1 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11470,7 +11470,8 @@ "tags": [ "migration" ], - "summary": "This API cancels a migration reindex attempt for a data stream or index", + "summary": "Cancel a reindex operation", + "description": "Cancel a migration reindex attempt for a data stream or index.", "operationId": "indices-cancel-migrate-reindex", "parameters": [ { @@ -12302,8 +12303,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 a destination from a source index", + "description": "This API copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.", "operationId": "indices-create-from", "parameters": [ { @@ -12327,8 +12328,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 a destination from a source index", + "description": "This API copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.", "operationId": "indices-create-from-1", "parameters": [ { @@ -14230,13 +14231,14 @@ "tags": [ "migration" ], - "summary": "This API returns the status of a migration reindex attempt for a data stream or index", + "summary": "Get the 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": { @@ -14593,8 +14595,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 e03f342fba..53d31de7c4 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 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 a destination from a source index.\n\nThis API copies the mappings and settings from the source 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 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", @@ -131927,7 +131927,7 @@ "body": { "kind": "no_body" }, - "description": "This API cancels a migration reindex attempt for a data stream or index", + "description": "Cancel a reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", "inherits": { "type": { "name": "RequestBase", @@ -131953,7 +131953,7 @@ } ], "query": [], - "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts#L23-L37" + "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts#L23-L38" }, { "kind": "response", @@ -132835,7 +132835,7 @@ } } ], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L45-L59" + "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L46-L60" }, { "kind": "request", @@ -132853,7 +132853,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 a destination from a source index.\n\nThis API copies the mappings and settings from the source index while allowing request settings and mappings to override the source values.", "inherits": { "type": { "name": "RequestBase", @@ -132891,7 +132891,7 @@ } ], "query": [], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L25-L43" + "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L25-L44" }, { "kind": "response", @@ -136599,7 +136599,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 reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", "inherits": { "type": { "name": "RequestBase", @@ -136612,7 +136612,7 @@ }, "path": [ { - "description": "The index or data stream name", + "description": "The index or data stream name.", "name": "index", "required": true, "type": { @@ -136625,7 +136625,7 @@ } ], "query": [], - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts#L23-L37" + "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts#L23-L38" }, { "kind": "response", @@ -137146,7 +137146,7 @@ } } ], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L36-L45" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L39-L48" }, { "kind": "enum", @@ -137159,7 +137159,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", @@ -137177,7 +137177,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", @@ -137190,7 +137190,7 @@ }, "path": [], "query": [], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L23-L34" + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L23-L37" }, { "kind": "response", @@ -137229,7 +137229,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..5c67e3a865 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 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..90c22cb050 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 a destination from a source index. * + * This API copies the mappings and settings from the source 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..3e8a4f5f0d 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 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 From d688710bcd8320a13e8fdc48dbda472ce39f5344 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 22 Jan 2025 21:24:16 -0800 Subject: [PATCH 2/2] Address feedback --- output/openapi/elasticsearch-openapi.json | 12 ++++++------ output/schema/schema.json | 12 ++++++------ .../MigrateCancelReindexRequest.ts | 2 +- .../indices/create_from/MigrateCreateFromRequest.ts | 4 ++-- .../MigrateGetReindexStatusRequest.ts | 2 +- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index bfb423adf1..946086e4a0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11470,7 +11470,7 @@ "tags": [ "migration" ], - "summary": "Cancel a reindex operation", + "summary": "Cancel a migration reindex operation", "description": "Cancel a migration reindex attempt for a data stream or index.", "operationId": "indices-cancel-migrate-reindex", "parameters": [ @@ -12303,8 +12303,8 @@ "tags": [ "migration" ], - "summary": "Create a destination from a source index", - "description": "This API 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": [ { @@ -12328,8 +12328,8 @@ "tags": [ "migration" ], - "summary": "Create a destination from a source index", - "description": "This API 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": [ { @@ -14231,7 +14231,7 @@ "tags": [ "migration" ], - "summary": "Get the reindexing status", + "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": [ diff --git a/output/schema/schema.json b/output/schema/schema.json index 53d31de7c4..d7fb0d13e8 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6279,7 +6279,7 @@ "stability": "experimental" } }, - "description": "Cancel a reindex operation.\n\nCancel 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": "Create a destination from a source index.\n\nThis API 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": "Get the reindexing status.\n\nGet 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", @@ -131927,7 +131927,7 @@ "body": { "kind": "no_body" }, - "description": "Cancel a reindex operation.\n\nCancel 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", @@ -132853,7 +132853,7 @@ } } }, - "description": "Create a destination from a source index.\n\nThis API 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", @@ -136599,7 +136599,7 @@ "body": { "kind": "no_body" }, - "description": "Get the reindexing status.\n\nGet 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", diff --git a/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts b/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts index 5c67e3a865..8f8513b81f 100644 --- a/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts +++ b/specification/indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Indices } from '@_types/common' /** - * Cancel a reindex operation. + * Cancel a migration reindex operation. * * Cancel a migration reindex attempt for a data stream or index. * @rest_spec_name indices.cancel_migrate_reindex diff --git a/specification/indices/create_from/MigrateCreateFromRequest.ts b/specification/indices/create_from/MigrateCreateFromRequest.ts index 90c22cb050..ed3951102a 100644 --- a/specification/indices/create_from/MigrateCreateFromRequest.ts +++ b/specification/indices/create_from/MigrateCreateFromRequest.ts @@ -23,9 +23,9 @@ import { IndexName } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' /** - * Create a destination from a source index. + * Create an index from a source index. * - * This API copies the mappings and settings from the source index while allowing request settings and mappings to override the source values. + * 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 3e8a4f5f0d..0f4eec021c 100644 --- a/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts +++ b/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Indices } from '@_types/common' /** - * Get the reindexing status. + * 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