Browse Source

Add docs on full_id parameter in cat nodes API

This commit adds a note to the docs on the full_id parameter in the cat
nodes API. This is a useful parameter but was not previously documented
anywhere.

Relates #27009
Jason Tedor 8 years ago
parent
commit
8eba1fa17c
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/reference/cat/nodes.asciidoc

+ 5 - 0
docs/reference/cat/nodes.asciidoc

@@ -27,6 +27,11 @@ The last (`node.role`, `master`, and `name`) columns provide ancillary
 information that can often be useful when looking at the cluster as a whole,
 particularly large ones.  How many master-eligible nodes do I have?
 
+The `nodes` API accepts an additional URL parameter `full_id` accepting `true`
+or `false`. The purpose of this parameter is to format the ID field (if
+requested with `id` or `nodeId`) in its full length or in abbreviated form (the
+default).
+
 [float]
 === Columns