[DOCS] Collapse nested objects in cluster reroute docs (#54851)

This commit is contained in:
Vishal Patel 2020-04-09 14:56:37 -04:00 committed by James Rodewig
parent 12f056b833
commit 51cb0c5c7b
1 changed files with 30 additions and 25 deletions

View File

@ -12,7 +12,6 @@ Changes the allocation of shards in a cluster.
`POST /_cluster/reroute`
[[cluster-reroute-api-desc]]
==== {api-description-title}
@ -55,6 +54,7 @@ query parameter, which will attempt a single retry round for these shards.
[[cluster-reroute-api-query-params]]
[role="child_attributes"]
==== {api-query-parms-title}
`dry_run`::
@ -70,7 +70,9 @@ query parameter, which will attempt a single retry round for these shards.
Defaults to all but metadata The following options are available:
+
--
.Options for `metric`
[%collapsible%open]
======
`_all`::
Shows all metrics.
@ -93,7 +95,8 @@ query parameter, which will attempt a single retry round for these shards.
`version`::
Shows the cluster state version.
--
======
`retry_failed`::
(Optional, boolean) If `true`, then retries allocation of shards that are
@ -101,15 +104,18 @@ query parameter, which will attempt a single retry round for these shards.
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[cluster-reroute-api-request-body]]
==== {api-request-body-title}
`commands`::
(Required, object) Defines the commands to perform. Supported commands are:
(Required, array of objects) Defines the commands to perform. Supported commands are:
+
--
.Properties of `commands`
[%collapsible%open]
======
`move`::
Move a started shard from one node to another node. Accepts `index` and
`shard` for index name and shard number, `from_node` for the node to move
@ -129,7 +135,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
Allocate an unassigned replica shard to a node. Accepts `index` and `shard`
for index name and shard number, and `node` to allocate the shard to. Takes
<<modules-cluster,allocation deciders>> into account.
--
Two more commands are available that allow the allocation of a primary shard to
a node. These commands should however be used with extreme care, as primary
@ -169,7 +174,7 @@ will be deleted or overwritten.
data rejoins the cluster later on, that data will be deleted. To ensure
that these implications are well-understood, this command requires the flag
`accept_data_loss` to be explicitly set to `true`.
======
[[cluster-reroute-api-example]]
==== {api-examples-title}