Skip to content

Commit

Permalink
[DOCS] Reformat cat master API
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Aug 6, 2019
1 parent 86c4a69 commit 83d3486
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions docs/reference/cat/master.asciidoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,44 @@
[[cat-master]]
=== cat master

`master` doesn't have any extra options. It simply displays the
master's node ID, bound IP address, and node name. For example:
Returns information about the master node, including the ID, bound IP address,
and name.


[[cat-master-api-request]]
==== {api-request-title}

`GET /_cat/master`


[[cat-master-api-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]

include::{docdir}/rest-api/common-parms.asciidoc[tag=help]

include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]


[[cat-master-api-example]]
==== {api-examples-title}

[source,js]
--------------------------------------------------
GET /_cat/master?v
--------------------------------------------------
// CONSOLE

might respond:
The API returns the following response:

[source,txt]
--------------------------------------------------
Expand Down

0 comments on commit 83d3486

Please sign in to comment.