diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index edeb04b90d..443e474fdf 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -101,8 +101,6 @@ actions: x-displayName: Index description: > Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates. - - name: dangling_indices - x-displayName: Index - Import dangling index - name: ilm x-displayName: Index lifecycle management externalDocs: diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index a4ee664ea5..b7c6eb9b4d 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -5863,15 +5863,16 @@ "/_dangling/{index_uuid}": { "post": { "tags": [ - "dangling_indices" + "indices" ], - "summary": "Imports the specified dangling index", + "summary": "Import a dangling index", + "description": "If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "operationId": "dangling-indices-import-dangling-index", "parameters": [ { "in": "path", "name": "index_uuid", - "description": "The UUID of the dangling index", + "description": "The UUID of the index to import. Use the get dangling indices API to locate the UUID.", "required": true, "deprecated": false, "schema": { @@ -5882,7 +5883,7 @@ { "in": "query", "name": "accept_data_loss", - "description": "Must be set to true in order to import the dangling index", + "description": "This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.", "required": true, "deprecated": false, "schema": { @@ -5927,15 +5928,16 @@ }, "delete": { "tags": [ - "dangling_indices" + "indices" ], - "summary": "Deletes the specified dangling index", + "summary": "Delete a dangling index", + "description": "If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "operationId": "dangling-indices-delete-dangling-index", "parameters": [ { "in": "path", "name": "index_uuid", - "description": "The UUID of the dangling index", + "description": "The UUID of the index to delete. Use the get dangling indices API to find the UUID.", "required": true, "deprecated": false, "schema": { @@ -5946,7 +5948,7 @@ { "in": "query", "name": "accept_data_loss", - "description": "Must be set to true in order to delete the dangling index", + "description": "This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.", "required": true, "deprecated": false, "schema": { @@ -5993,9 +5995,10 @@ "/_dangling": { "get": { "tags": [ - "dangling_indices" + "indices" ], - "summary": "Returns all dangling indices", + "summary": "Get the dangling indices", + "description": "If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "operationId": "dangling-indices-list-dangling-indices", "responses": { "200": { diff --git a/output/schema/schema.json b/output/schema/schema.json index b16bede10e..9cae2fd7f7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4167,7 +4167,8 @@ "stability": "stable" } }, - "description": "Deletes the specified dangling index", + "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.delete_dangling_index", "request": { @@ -4198,7 +4199,8 @@ "stability": "stable" } }, - "description": "Imports the specified dangling index", + "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.import_dangling_index", "request": { @@ -4229,7 +4231,8 @@ "stability": "stable" } }, - "description": "Returns all dangling indices.", + "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.list_dangling_indices", "request": { @@ -115373,7 +115376,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes the specified dangling index", + "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "inherits": { "type": { "name": "RequestBase", @@ -115386,7 +115389,7 @@ }, "path": [ { - "description": "The UUID of the dangling index", + "description": "The UUID of the index to delete. Use the get dangling indices API to find the UUID.", "name": "index_uuid", "required": true, "type": { @@ -115400,7 +115403,7 @@ ], "query": [ { - "description": "Must be set to true in order to delete the dangling index", + "description": "This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.", "name": "accept_data_loss", "required": true, "type": { @@ -115436,7 +115439,7 @@ } } ], - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L37" + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L48" }, { "kind": "response", @@ -115464,7 +115467,7 @@ "body": { "kind": "no_body" }, - "description": "Imports the specified dangling index", + "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "inherits": { "type": { "name": "RequestBase", @@ -115477,7 +115480,7 @@ }, "path": [ { - "description": "The UUID of the dangling index", + "description": "The UUID of the index to import. Use the get dangling indices API to locate the UUID.", "name": "index_uuid", "required": true, "type": { @@ -115491,7 +115494,7 @@ ], "query": [ { - "description": "Must be set to true in order to import the dangling index", + "description": "This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.", "name": "accept_data_loss", "required": true, "type": { @@ -115527,7 +115530,7 @@ } } ], - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L37" + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L49" }, { "kind": "response", @@ -115618,7 +115621,7 @@ "body": { "kind": "no_body" }, - "description": "Returns all dangling indices.", + "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "inherits": { "type": { "name": "RequestBase", @@ -115631,7 +115634,7 @@ }, "path": [], "query": [], - "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L26" + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L33" }, { "kind": "response", diff --git a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts index 914457e8c4..ae4135c600 100644 --- a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts +++ b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts @@ -22,14 +22,25 @@ import { Uuid } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete a dangling index. + * + * If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + * For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. * @rest_spec_name dangling_indices.delete_dangling_index * @availability stack since=7.9.0 stability=stable + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { + /** + * The UUID of the index to delete. Use the get dangling indices API to find the UUID. + */ index_uuid: Uuid } query_parameters: { + /** + * This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. + */ accept_data_loss: boolean master_timeout?: Duration timeout?: Duration diff --git a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts index 25503373b8..559280bf85 100644 --- a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts +++ b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts @@ -22,14 +22,26 @@ import { Uuid } from '@_types/common' import { Duration } from '@_types/Time' /** + * Import a dangling index. + * + * If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + * For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. * @rest_spec_name dangling_indices.import_dangling_index * @availability stack since=7.9.0 stability=stable + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { + /** + * The UUID of the index to import. Use the get dangling indices API to locate the UUID. + */ index_uuid: Uuid } query_parameters: { + /** + * This parameter must be set to true to import a dangling index. + * Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. + */ accept_data_loss: boolean master_timeout?: Duration timeout?: Duration diff --git a/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts index 9d4479fe2e..1a99461891 100644 --- a/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts +++ b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts @@ -20,7 +20,14 @@ import { RequestBase } from '@_types/Base' /** + * Get the dangling indices. + * + * If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + * For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. + * + * Use this API to list dangling indices, which you can then import or delete. * @rest_spec_name dangling_indices.list_dangling_indices * @availability stack since=7.9.0 stability=stable + * @doc_tag indices */ export interface Request extends RequestBase {}