Skip to content

Commit

Permalink
Add docs on full_id parameter in cat nodes API
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jasontedor committed Oct 13, 2017
1 parent 567dd07 commit dcdbd70
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/reference/cat/nodes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit dcdbd70

Please sign in to comment.