Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS authored Jul 18, 2024
1 parent 210b41b commit e583b73
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions _api-reference/index-apis/recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ parent: Index APIs
nav_order: 62
---

# Recover Index
# Recover an index
Introduced 1.0
{: .label .label-purple }

The Recover Index API gives information about any completed or ongoing shard recoveries for one or more indexes. If a data stream is listed, the API returns information about that data stream's backing index.
The Recover index API gives information about any completed or ongoing shard recoveries for one or more indexes. If a data stream is listed, the API returns information about that data stream's backing index.

Shard recovery is the process of starting a shard copy for restoring a primary shard from a snapshot or syncing a replica shard. Once a shard recovery is complete, the recovered shard becomes available for searching and indexing operations.

Expand All @@ -24,7 +24,7 @@ Shard recovery occurs automatically in the following scenarios:
The Recover Index API provides information only about completed recoveries for shard copies that currently exist in the cluster. It reports only the most recent recovery for each shard copy and does not include historical information about previous recoveries or information about recoveries of shard copies that no longer exist. Consequently, if a shard copy completes a recovery and is subsequently relocated to a different node, the information about the original recovery will not be displayed in the Recover Index API.


## HTTP and Path Methods
## HTTP and Path methods

Check failure on line 27 in _api-reference/index-apis/recover.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _api-reference/index-apis/recover.md#L27

[OpenSearch.HeadingCapitalization] 'HTTP and Path methods' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'HTTP and Path methods' is a heading and should be in sentence case.", "location": {"path": "_api-reference/index-apis/recover.md", "range": {"start": {"line": 27, "column": 4}}}, "severity": "ERROR"}

```
GET /_recovery
Expand Down Expand Up @@ -61,7 +61,7 @@ Parameter | Type | Description
`start_time` | String | The timestamp for when the recovery started.
`stop_time` | String | The timestamp for when the recovery finished.
`total_time_in_millis` | String | The total time to recover shard in milliseconds.
`source` | Object | The recovery source. This can include repository description if recovery is from a snapshot or a description of source node.
`source` | Object | The recovery source. This can include a repository description if recovery is from a snapshot or a description of source node.
`target` | Object | The destination node.
`index` | Object | The statistics about physical index recovery.
`translog` | Object | The statistics about translog recovery.
Expand Down

0 comments on commit e583b73

Please sign in to comment.