Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Reformats cat plugins API #45344

Merged
merged 1 commit into from
Aug 9, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions docs/reference/cat/plugins.asciidoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,43 @@
[[cat-plugins]]
=== cat plugins

The `plugins` command provides a view per node of running plugins. This information *spans nodes*.
Returns a list of plugins running on each node of a cluster.


[[cat-plugins-tasks-api-request]]
==== {api-request-title}

`GET /_cat/plugins`


[[cat-plugins-tasks-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-plugins-api-example]]
==== {api-examples-title}

[source,js]
------------------------------------------------------------------------------
GET /_cat/plugins?v&s=component&h=name,component,version,description
------------------------------------------------------------------------------
// CONSOLE

Might look like:
The API returns the following response:

["source","txt",subs="attributes,callouts"]
------------------------------------------------------------------------------
Expand All @@ -31,6 +59,4 @@ U7321H6 mapper-size {version_qualified} The Mapper Size plugin allow
U7321H6 store-smb {version_qualified} The Store SMB plugin adds support for SMB stores.
U7321H6 transport-nio {version_qualified} The nio transport.
------------------------------------------------------------------------------
// TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ non_json]

We can tell quickly how many plugins per node we have and which versions.
// TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ non_json]