Browse Source

[DOCS] Fix `type` response values for index recovery API (#81000)

We updated the `type` response values in https://github.com/elastic/elasticsearch/pull/19516. This updates the docs with the correct values.

Closes https://github.com/elastic/elasticsearch/issues/80264

Co-authored-by: David Turner <david.turner@elastic.co>
James Rodewig 3 years ago
parent
commit
2a30dfe4d2
1 changed files with 22 additions and 20 deletions
  1. 22 20
      docs/reference/indices/recovery.asciidoc

+ 22 - 20
docs/reference/indices/recovery.asciidoc

@@ -44,12 +44,12 @@ the replica shard is available for search.
 
 
 Recovery automatically occurs during the following processes:
 Recovery automatically occurs during the following processes:
 
 
-* Node startup or failure. This type of recovery is called a local store
-  recovery.
+* Node startup. This type of recovery is called a local store recovery.
 * Primary shard replication.
 * Primary shard replication.
 * Relocation of a shard to a different node in the same cluster.
 * Relocation of a shard to a different node in the same cluster.
-* <<snapshots-restore-snapshot,Snapshot restoration>>.
-
+* <<snapshots-restore-snapshot,Snapshot restore>> operation.
+* <<indices-clone-index,Clone>>, <<indices-shrink-index,shrink>>, or
+<<indices-split-index,split>> operation.
 // end::shard-recovery-desc[]
 // end::shard-recovery-desc[]
 
 
 [[index-recovery-api-path-params]]
 [[index-recovery-api-path-params]]
@@ -80,26 +80,28 @@ ID of the shard.
 `type`::
 `type`::
 +
 +
 --
 --
-(String)
-Recovery type.
-Returned values include:
+(String) Recovery source for the shard. Returned values include:
 
 
-`STORE`::
-The recovery is related to
-a node startup or failure.
-This type of recovery is called a local store recovery.
+`EMPTY_STORE`::
+An empty store. Indicates a new primary shard or the forced allocation of an
+empty primary shard using the <<cluster-reroute,cluster reroute API>>.
 
 
-`SNAPSHOT`::
-The recovery is related to
-a <<snapshots-restore-snapshot,snapshot restoration>>.
+`EXISTING_STORE`::
+The store of an existing primary shard. Indicates recovery is related
+to node startup or the allocation of an existing primary shard.
 
 
-`REPLICA`::
-The recovery is related to a primary shard replication.
+`LOCAL_SHARDS`::
+Shards of another index on the same node. Indicates recovery is related to a
+<<indices-clone-index,clone>>, <<indices-shrink-index,shrink>>, or
+<<indices-split-index,split>> operation.
 
 
-`RELOCATING`::
-The recovery is related to
-the relocation of a shard
-to a different node in the same cluster.
+`PEER`::
+A primary shard on another node. Indicates recovery is related to shard
+replication.
+
+`SNAPSHOT`::
+A snapshot. Indicates recovery is related to a
+<<snapshots-restore-snapshot,snapshot restore>> operation.
 --
 --
 
 
 `STAGE`::
 `STAGE`::