Improvements to get docs to build
This commit is contained in:
@ -24,17 +24,22 @@
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
++++
|
||||
<style>
|
||||
.lang-ts a.xref {
|
||||
text-decoration: underline !important;
|
||||
}
|
||||
</style>
|
||||
++++
|
||||
|
||||
[discrete]
|
||||
[[client.cat.recovery]]
|
||||
=== client.cat.recovery
|
||||
== client.cat.recovery
|
||||
|
||||
Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
|
||||
|
||||
{ref}/cat-recovery.html[{es} documentation]
|
||||
|
||||
[discrete]
|
||||
==== Function signature
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
@ -42,12 +47,10 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
|
||||
----
|
||||
|
||||
[discrete]
|
||||
==== Request
|
||||
=== Request
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatRecoveryRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
active_only?: boolean
|
||||
@ -55,20 +58,14 @@ interface CatRecoveryRequest extends <<CatCatRequestBase>> {
|
||||
detailed?: boolean
|
||||
}
|
||||
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
[discrete]
|
||||
==== Response
|
||||
----
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
|
||||
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
----
|
||||
|
||||
|
||||
Reference in New Issue
Block a user