[OpenAPI] Edits dangling index APIs (#3055) (#3067)

Author: github-actions[bot]

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:

output/openapi/elasticsearch-openapi.json

@@ -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

output/schema/schema.json

@@ -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

specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.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 {}