honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-26 01:48:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reformat cat master API (#45240)

Browse Source
This commit is contained in:
James Rodewig 2019-08-07 09:03:31 -04:00
parent 15d41a7508
commit d8423f0a80
1 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/reference/cat/master.asciidoc
View File

@ -1,8 +1,36 @@
[[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]
--------------------------------------------------
@ -10,7 +38,7 @@ GET /_cat/master?v
--------------------------------------------------
// CONSOLE
might respond:
The API returns the following response:
[source,txt]
--------------------------------------------------