From bc6917530347db9fbb3da05cba7bfff3b4ec4ca0 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 22 Oct 2019 12:27:31 -0500 Subject: [PATCH] [DOCS] Sort cluster API docs alphabetically (#48198) --- docs/reference/cluster.asciidoc | 22 +++++++++---------- .../cluster/allocation-explain.asciidoc | 5 ++++- docs/reference/cluster/get-settings.asciidoc | 5 ++++- docs/reference/cluster/health.asciidoc | 5 ++++- .../cluster/nodes-hot-threads.asciidoc | 5 ++++- docs/reference/cluster/nodes-info.asciidoc | 5 ++++- docs/reference/cluster/nodes-stats.asciidoc | 5 ++++- docs/reference/cluster/nodes-usage.asciidoc | 5 ++++- docs/reference/cluster/pending.asciidoc | 5 ++++- docs/reference/cluster/remote-info.asciidoc | 5 ++++- docs/reference/cluster/reroute.asciidoc | 5 ++++- docs/reference/cluster/state.asciidoc | 5 ++++- docs/reference/cluster/stats.asciidoc | 5 ++++- .../cluster/update-settings.asciidoc | 5 ++++- .../cluster/voting-exclusions.asciidoc | 2 +- 15 files changed, 64 insertions(+), 25 deletions(-) diff --git a/docs/reference/cluster.asciidoc b/docs/reference/cluster.asciidoc index 57f62a4faac0..271a7d7fbbb5 100644 --- a/docs/reference/cluster.asciidoc +++ b/docs/reference/cluster.asciidoc @@ -79,32 +79,32 @@ GET /_nodes/ra*:2 GET /_nodes/ra*:2* -------------------------------------------------- +include::cluster/allocation-explain.asciidoc[] + +include::cluster/get-settings.asciidoc[] + include::cluster/health.asciidoc[] +include::cluster/reroute.asciidoc[] + include::cluster/state.asciidoc[] include::cluster/stats.asciidoc[] -include::cluster/pending.asciidoc[] - -include::cluster/reroute.asciidoc[] - include::cluster/update-settings.asciidoc[] -include::cluster/get-settings.asciidoc[] +include::cluster/nodes-usage.asciidoc[] -include::cluster/nodes-stats.asciidoc[] +include::cluster/nodes-hot-threads.asciidoc[] include::cluster/nodes-info.asciidoc[] -include::cluster/nodes-usage.asciidoc[] +include::cluster/nodes-stats.asciidoc[] + +include::cluster/pending.asciidoc[] include::cluster/remote-info.asciidoc[] include::cluster/tasks.asciidoc[] -include::cluster/nodes-hot-threads.asciidoc[] - -include::cluster/allocation-explain.asciidoc[] - include::cluster/voting-exclusions.asciidoc[] diff --git a/docs/reference/cluster/allocation-explain.asciidoc b/docs/reference/cluster/allocation-explain.asciidoc index 851f0a6c076e..fc407f069a0e 100644 --- a/docs/reference/cluster/allocation-explain.asciidoc +++ b/docs/reference/cluster/allocation-explain.asciidoc @@ -1,5 +1,8 @@ [[cluster-allocation-explain]] -=== Cluster Allocation Explain API +=== Cluster allocation explain API +++++ +Cluster allocation explain +++++ Provides explanations for shard allocations in the cluster. diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index 32661bdaf462..ba199e054c30 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -1,5 +1,8 @@ [[cluster-get-settings]] -=== Cluster Get Settings +=== Cluster get settings API +++++ +Cluster get settings +++++ Returns cluster-wide settings. diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index 553a23fcd8f7..facb8ea57ad9 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -1,5 +1,8 @@ [[cluster-health]] -=== Cluster Health +=== Cluster health API +++++ +Cluster health +++++ Returns the health status of a cluster. diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index ec248f5d253a..b8cd88494bcd 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -1,5 +1,8 @@ [[cluster-nodes-hot-threads]] -=== Nodes hot_threads +=== Nodes hot threads API +++++ +Nodes hot threads +++++ Returns the hot threads on each selected node in the cluster. diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index d5408ae7cbae..5706ef3fd93e 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -1,5 +1,8 @@ [[cluster-nodes-info]] -=== Nodes Info +=== Nodes info API +++++ +Nodes info +++++ Returns cluster nodes information. diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 7c51516957f3..a08896e0d8b5 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -1,5 +1,8 @@ [[cluster-nodes-stats]] -=== Nodes Stats +=== Nodes stats API +++++ +Nodes stats +++++ Returns cluster nodes statistics. diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index 24032d914e8f..503568b00069 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -1,5 +1,8 @@ [[cluster-nodes-usage]] -=== Nodes Feature Usage +=== Nodes feature usage API +++++ +Nodes feature usage +++++ Returns information on the usage of features. diff --git a/docs/reference/cluster/pending.asciidoc b/docs/reference/cluster/pending.asciidoc index 82b9fd9732a5..79d17cd37b72 100644 --- a/docs/reference/cluster/pending.asciidoc +++ b/docs/reference/cluster/pending.asciidoc @@ -1,5 +1,8 @@ [[cluster-pending]] -=== Pending cluster tasks +=== Pending cluster tasks API +++++ +Pending cluster tasks +++++ Returns cluster-level changes that have not yet been executed. diff --git a/docs/reference/cluster/remote-info.asciidoc b/docs/reference/cluster/remote-info.asciidoc index d9f451739564..d7eff24e576d 100644 --- a/docs/reference/cluster/remote-info.asciidoc +++ b/docs/reference/cluster/remote-info.asciidoc @@ -1,5 +1,8 @@ [[cluster-remote-info]] -=== Remote Cluster Info +=== Remote cluster info API +++++ +Remote cluster info +++++ Returns configured remote cluster information. diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index 9d7b3ae62196..94e2367b96e7 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -1,5 +1,8 @@ [[cluster-reroute]] -=== Cluster Reroute +=== Cluster reroute API +++++ +Cluster reroute +++++ Changes the allocation of shards in a cluster. diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 554925a3b171..567635c4d4bf 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -1,5 +1,8 @@ [[cluster-state]] -=== Cluster State +=== Cluster state API +++++ +Cluster state +++++ Returns metadata about the state of the cluster. diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index aafd6fd4b991..dbb4ea25d365 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -1,5 +1,8 @@ [[cluster-stats]] -=== Cluster Stats +=== Cluster stats API +++++ +Cluster stats +++++ Returns cluster statistics. diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index 5a2c96532ba5..9179e88b6526 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -1,5 +1,8 @@ [[cluster-update-settings]] -=== Cluster Update Settings +=== Cluster update settings API +++++ +Cluster update settings +++++ Updates cluster-wide settings. diff --git a/docs/reference/cluster/voting-exclusions.asciidoc b/docs/reference/cluster/voting-exclusions.asciidoc index 28412620d2d9..a2689cb57037 100644 --- a/docs/reference/cluster/voting-exclusions.asciidoc +++ b/docs/reference/cluster/voting-exclusions.asciidoc @@ -1,7 +1,7 @@ [[voting-config-exclusions]] === Voting configuration exclusions API ++++ -Voting Configuration Exclusions +Voting configuration exclusions ++++ Adds or removes master-eligible nodes from the