浏览代码

[DOCS] Reformat cat API titles (#45407)

James Rodewig 6 年之前
父节点
当前提交
e0c9234ba9

+ 4 - 1
docs/reference/cat/alias.asciidoc

@@ -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.

+ 5 - 1
docs/reference/cat/allocation.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/count.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/fielddata.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/health.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/indices.asciidoc

@@ -1,5 +1,8 @@
 [[cat-indices]]
-=== cat indices
+=== cat indices API
+++++
+<titleabbrev>cat indices</titleabbrev>
+++++
 
 Returns high-level information about indices in a cluster.
 

+ 4 - 1
docs/reference/cat/master.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/nodeattrs.asciidoc

@@ -1,5 +1,8 @@
 [[cat-nodeattrs]]
-=== cat nodeattrs
+=== cat nodeattrs API
+++++
+<titleabbrev>cat nodeattrs</titleabbrev>
+++++
 
 Returns information about custom node attributes.
 

+ 4 - 1
docs/reference/cat/nodes.asciidoc

@@ -1,5 +1,8 @@
 [[cat-nodes]]
-=== cat nodes
+=== cat nodes API
+++++
+<titleabbrev>cat nodes</titleabbrev>
+++++
 
 Returns information about a cluster's nodes.
 

+ 4 - 1
docs/reference/cat/pending_tasks.asciidoc

@@ -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.

+ 4 - 1
docs/reference/cat/plugins.asciidoc

@@ -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.
 

+ 4 - 1
docs/reference/cat/recovery.asciidoc

@@ -1,5 +1,8 @@
 [[cat-recovery]]
-=== cat recovery
+=== cat recovery API
+++++
+<titleabbrev>cat recovery</titleabbrev>
+++++
 
 Returns information about ongoing and completed index shard recoveries, similar
 to the <<indices-recovery, indices recovery>> API.

+ 4 - 1
docs/reference/cat/repositories.asciidoc

@@ -1,5 +1,8 @@
 [[cat-repositories]]
-=== cat repositories
+=== cat repositories API
+++++
+<titleabbrev>cat repositories</titleabbrev>
+++++
 
 Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
 

+ 4 - 1
docs/reference/cat/segments.asciidoc

@@ -1,5 +1,8 @@
 [[cat-segments]]
-=== cat segments
+=== cat segments API
+++++
+<titleabbrev>cat segments</titleabbrev>
+++++
 
 Returns low-level information about the https://lucene.apache.org/core/[Lucene]
 segments in index shards, similar to the <<indices-segments, indices segments>>

+ 4 - 1
docs/reference/cat/shards.asciidoc

@@ -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

+ 4 - 1
docs/reference/cat/snapshots.asciidoc

@@ -1,5 +1,8 @@
 [[cat-snapshots]]
-=== cat snapshots
+=== cat snapshots API
+++++
+<titleabbrev>cat snapshots</titleabbrev>
+++++
 
 Returns information about the <<modules-snapshots,snapshots>> stored in one or
 more repositories. A snapshot is a backup of an index or running {es} cluster.

+ 4 - 1
docs/reference/cat/templates.asciidoc

@@ -1,5 +1,8 @@
 [[cat-templates]]
-=== cat templates
+=== cat templates API
+++++
+<titleabbrev>cat templates</titleabbrev>
+++++
 
 Returns information about <<indices-templates,index templates>> in a cluster.
 You can use index templates to apply <<index-modules-settings,index settings>>

+ 4 - 1
docs/reference/cat/thread_pool.asciidoc

@@ -1,5 +1,8 @@
 [[cat-thread-pool]]
-=== cat thread pool
+=== cat thread pool API
+++++
+<titleabbrev>cat thread pool</titleabbrev>
+++++
 
 Returns thread pool statistics for each node in a cluster. Returned information
 includes all <<modules-threadpool,built-in thread pools>> and custom thread