Skip to content

Commit 0ab8f04

Browse files
authored
[DOCS] Reformats cat plugins API (#45344)
1 parent c42dd74 commit 0ab8f04

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

docs/reference/cat/plugins.asciidoc

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,43 @@
11
[[cat-plugins]]
22
=== cat plugins
33

4-
The `plugins` command provides a view per node of running plugins. This information *spans nodes*.
4+
Returns a list of plugins running on each node of a cluster.
5+
6+
7+
[[cat-plugins-tasks-api-request]]
8+
==== {api-request-title}
9+
10+
`GET /_cat/plugins`
11+
12+
13+
[[cat-plugins-tasks-api-query-params]]
14+
==== {api-query-parms-title}
15+
16+
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
17+
18+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
19+
20+
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
21+
22+
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
23+
24+
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
25+
26+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
27+
28+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
29+
30+
31+
[[cat-plugins-api-example]]
32+
==== {api-examples-title}
533

634
[source,js]
735
------------------------------------------------------------------------------
836
GET /_cat/plugins?v&s=component&h=name,component,version,description
937
------------------------------------------------------------------------------
1038
// CONSOLE
1139

12-
Might look like:
40+
The API returns the following response:
1341

1442
["source","txt",subs="attributes,callouts"]
1543
------------------------------------------------------------------------------
@@ -31,6 +59,4 @@ U7321H6 mapper-size {version_qualified} The Mapper Size plugin allow
3159
U7321H6 store-smb {version_qualified} The Store SMB plugin adds support for SMB stores.
3260
U7321H6 transport-nio {version_qualified} The nio transport.
3361
------------------------------------------------------------------------------
34-
// TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ non_json]
35-
36-
We can tell quickly how many plugins per node we have and which versions.
62+
// TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ non_json]

0 commit comments

Comments
 (0)