Browse Source

[DOCS] Reformats voting configuration exclusion API. (#45644)

István Zoltán Szabó 6 years ago
parent
commit
e134947b6e
1 changed files with 32 additions and 22 deletions
  1. 32 22
      docs/reference/cluster/voting-exclusions.asciidoc

+ 32 - 22
docs/reference/cluster/voting-exclusions.asciidoc

@@ -7,21 +7,17 @@
 Adds or removes master-eligible nodes from the
 <<modules-discovery-voting,voting configuration exclusion list>>.
 
-[float]
-==== Request
 
-`POST _cluster/voting_config_exclusions/<node_name>` +
+[[voting-config-exclusions-api-request]]
+==== {api-request-title}
 
-`DELETE _cluster/voting_config_exclusions`
+`POST _cluster/voting_config_exclusions/{node_name}` +
 
-[float]
-==== Path parameters
+`DELETE _cluster/voting_config_exclusions`
 
-`node_name`::
-  A <<cluster-nodes,node filter>> that identifies {es} nodes.
 
-[float]
-==== Description
+[[voting-config-exclusions-api-desc]]
+==== {api-description-title}
   
 By default, if there are more than three master-eligible nodes in the cluster
 and you remove fewer than half of the master-eligible nodes in the cluster at
@@ -44,23 +40,35 @@ master-eligible nodes from a cluster in a short time period. They are not
 required when removing master-ineligible nodes or fewer than half of the
 master-eligible nodes.
 
-The <<modules-discovery-settings,`cluster.max_voting_config_exclusions`
-setting>> limits the size of the voting configuration exclusion list. The
-default value is `10`. Since voting configuration exclusions are persistent and
-limited in number, you must clear the voting config exclusions list once the
-exclusions are no longer required.
+For more information, see <<modules-discovery-removing-nodes>>.
+
 
-There is also a
-<<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` setting>>,
-which is set to true by default. If it is set to false, you must use this API to
-maintain the voting configuration.
+[[voting-config-exclusions-api-path-params]]
+==== {api-path-parms-title}
+
+`{node_name}`::
+  A <<cluster-nodes,node filter>> that identifies {es} nodes.
 
-For more information, see <<modules-discovery-removing-nodes>>.
 
-[float]
-==== Examples
+[[voting-config-exclusions-api-query-params]]
+==== {api-query-parms-title}
+
+`cluster.auto_shrink_voting_configuration`::
+    (Optional, boolean) If `false`, you must use this API to maintain the voting 
+    configuration. Defaults to `true`.
+
+`cluster.max_voting_config_exclusions`::
+    (Optional, integer) Limits the size of the voting configuration exclusion 
+    list. The default value is `10`. Since voting configuration exclusions are 
+    persistent and limited in number, you must clear the voting config 
+    exclusions list once the exclusions are no longer required.
+
+  
+[[voting-config-exclusions-api-example]]
+==== {api-examples-title}
 
 Add `nodeId1` to the voting configuration exclusions list:
+
 [source,js]
 -------------------------------------------------- 
 POST /_cluster/voting_config_exclusions/nodeId1
@@ -68,7 +76,9 @@ POST /_cluster/voting_config_exclusions/nodeId1
 // CONSOLE
 // TEST[catch:bad_request]
 
+
 Remove all exclusions from the list:
+
 [source,js]
 --------------------------------------------------
 DELETE /_cluster/voting_config_exclusions