Skip to content

[DOCS] Reformat cat API titles #45407

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

Merged
merged 1 commit into from
Aug 13, 2019
Merged
Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion docs/reference/cat/alias.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-alias]]
=== cat aliases
=== cat aliases API
++++
<titleabbrev>cat aliases</titleabbrev>
++++

Returns information about currently configured aliases to indices, including
filter and routing information.
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/cat/allocation.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
[[cat-allocation]]
=== cat allocation
=== cat allocation API
++++
<titleabbrev>cat allocation</titleabbrev>
++++


Provides a snapshot of the number of shards allocated to each data node
and their disk space.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/count.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-count]]
=== cat count
=== cat count API
++++
<titleabbrev>cat count</titleabbrev>
++++

Provides quick access to a document count of individual indices or all indices
in a cluster.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/fielddata.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-fielddata]]
=== cat fielddata
=== cat fielddata API
++++
<titleabbrev>cat fielddata</titleabbrev>
++++

Returns the amount of heap memory currently used by fielddata on every data node
in the cluster.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/health.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-health]]
=== cat health
=== cat health API
++++
<titleabbrev>cat health</titleabbrev>
++++

Returns the health status of a cluster, similar to the <<cluster-health,cluster
health>> API.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/indices.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-indices]]
=== cat indices
=== cat indices API
++++
<titleabbrev>cat indices</titleabbrev>
++++

Returns high-level information about indices in a cluster.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/master.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-master]]
=== cat master
=== cat master API
++++
<titleabbrev>cat master</titleabbrev>
++++

Returns information about the master node, including the ID, bound IP address,
and name.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/nodeattrs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-nodeattrs]]
=== cat nodeattrs
=== cat nodeattrs API
++++
<titleabbrev>cat nodeattrs</titleabbrev>
++++

Returns information about custom node attributes.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/nodes.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-nodes]]
=== cat nodes
=== cat nodes API
++++
<titleabbrev>cat nodes</titleabbrev>
++++

Returns information about a cluster's nodes.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/pending_tasks.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-pending-tasks]]
=== cat pending tasks
=== cat pending tasks API
++++
<titleabbrev>cat pending tasks</titleabbrev>
++++

Returns cluster-level changes that have not yet been executed, similar to the
<<cluster-pending, pending cluster tasks>> API.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/plugins.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-plugins]]
=== cat plugins
=== cat plugins API
++++
<titleabbrev>cat plugins</titleabbrev>
++++

Returns a list of plugins running on each node of a cluster.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/recovery.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-recovery]]
=== cat recovery
=== cat recovery API
++++
<titleabbrev>cat recovery</titleabbrev>
++++

The `recovery` command is a view of index shard recoveries, both on-going and previously
completed. It is a more compact view of the JSON <<indices-recovery,recovery>> API.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/repositories.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-repositories]]
=== cat repositories
=== cat repositories API
++++
<titleabbrev>cat repositories</titleabbrev>
++++

The `repositories` command shows the snapshot repositories registered in the
cluster. For example:
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/segments.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-segments]]
=== cat segments
=== cat segments API
++++
<titleabbrev>cat segments</titleabbrev>
++++

The `segments` command provides low level information about the segments
in the shards of an index. It provides information similar to the
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/shards.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-shards]]
=== cat shards
=== cat shards API
++++
<titleabbrev>cat shards</titleabbrev>
++++

The `shards` command is the detailed view of what nodes contain which
shards. It will tell you if it's a primary or replica, the number of
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/snapshots.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-snapshots]]
=== cat snapshots
=== cat snapshots API
++++
<titleabbrev>cat snapshots</titleabbrev>
++++

The `snapshots` command shows all snapshots that belong to a specific repository
or multiple repositories.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/templates.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-templates]]
=== cat templates
=== cat templates API
++++
<titleabbrev>cat templates</titleabbrev>
++++

The `templates` command provides information about existing templates.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/cat/thread_pool.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[cat-thread-pool]]
=== cat thread pool
=== cat thread pool API
++++
<titleabbrev>cat thread pool</titleabbrev>
++++

The `thread_pool` command shows cluster wide thread pool statistics per node. By default the active, queue and rejected
statistics are returned for all thread pools.
Expand Down