[DOCS] Edit cat operation summaries

elastic · Dec 4, 2024 · 0f5f0ed · 0f5f0ed
1 parent 8c4e5ee
commit 0f5f0ed
Show file tree

Hide file tree

Showing 17 changed files with 33 additions and 18 deletions.
diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes, NodeIds } from '@_types/common'
 
 /**
- * Provides a snapshot of the number of shards allocated to each data node and their disk space.
+ * Get shard allocation information.
+ * Get a snapshot of the number of shards allocated to each data node and their disk space.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
  * @rest_spec_name cat.allocation
  * @availability stack stability=stable

diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes, Fields } from '@_types/common'
 
 /**
- * Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
+ * Get field data cache information.
+ * Get the amount of heap memory currently used by the field data cache on every data node in the cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.
  * They are not intended for use by applications. For application consumption, use the nodes stats API.
  * @rest_spec_name cat.fielddata

diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts
@@ -21,7 +21,7 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { TimeUnit } from '@_types/Time'
 
 /**
- * Returns the health status of a cluster, similar to the cluster health API.
+ * Get the cluster health status.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.
  * They are not intended for use by applications. For application consumption, use the cluster health API.
  * This API is often used to check malfunctioning clusters.

diff --git a/specification/cat/master/CatMasterRequest.ts b/specification/cat/master/CatMasterRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns information about the master node, including the ID, bound IP address, and name.
+ * Get master node information.
+ * Get information about the master node, including the ID, bound IP address, and name.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
  * @rest_spec_name cat.master
  * @availability stack stability=stable

diff --git a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns information about custom node attributes.
+ * Get node attribute information.
+ * Get information about custom node attributes.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
  * @rest_spec_name cat.nodeattrs
  * @availability stack stability=stable

diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes } from '@_types/common'
 
 /**
- * Returns information about the nodes in a cluster.
+ * Get node information.
+ * Get information about the nodes in a cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
  * @rest_spec_name cat.nodes
  * @availability stack stability=stable

diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns cluster-level changes that have not yet been executed.
+ * Get pending task information.
+ * Get information about cluster-level changes that have not yet taken effect.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
  * @rest_spec_name cat.pending_tasks
  * @availability stack stability=stable

diff --git a/specification/cat/plugins/CatPluginsRequest.ts b/specification/cat/plugins/CatPluginsRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns a list of plugins running on each node of a cluster.
+ * Get plugin information.
+ * Get a list of plugins running on each node of a cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
  * @rest_spec_name cat.plugins
  * @availability stack stability=stable

diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes, Indices } from '@_types/common'
 
 /**
- * Returns information about ongoing and completed shard recoveries.
+ * Get shard recovery information.
+ * Get information about ongoing and completed shard recoveries.
  * Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.
  * For data streams, the API returns information about the stream’s backing indices.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

diff --git a/specification/cat/repositories/CatRepositoriesRequest.ts b/specification/cat/repositories/CatRepositoriesRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns the snapshot repositories for a cluster.
+ * Get snapshot repository information.
+ * Get a list of snapshot repositories for a cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
  * @rest_spec_name cat.repositories
  * @availability stack since=2.1.0 stability=stable

diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes, Indices } from '@_types/common'
 
 /**
- * Returns low-level information about the Lucene segments in index shards.
+ * Get segment information.
+ * Get low-level information about the Lucene segments in index shards.
  * For data streams, the API returns information about the backing indices.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
  * @rest_spec_name cat.segments

diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Bytes, Indices } from '@_types/common'
 
 /**
- * Returns information about the shards in a cluster.
+ * Get shard information.
+ * Get information about the shards in a cluster.
  * For data streams, the API returns information about the backing indices.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
  * @rest_spec_name cat.shards

diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Names } from '@_types/common'
 
 /**
- * Returns information about the snapshots stored in one or more repositories.
+ * Get snapshot information
+ * Get information about the snapshots stored in one or more repositories.
  * A snapshot is a backup of an index or running Elasticsearch cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
  * @rest_spec_name cat.snapshots

diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts
@@ -20,7 +20,8 @@
 import { CatRequestBase } from '@cat/_types/CatBase'
 
 /**
- * Returns information about tasks currently executing in the cluster.
+ * Get task information.
+ * Get information about tasks currently running in the cluster.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
  * @rest_spec_name cat.tasks
  * @availability stack since=5.0.0 stability=experimental

diff --git a/specification/cat/templates/CatTemplatesRequest.ts b/specification/cat/templates/CatTemplatesRequest.ts
@@ -21,7 +21,8 @@ import { CatRequestBase } from '@cat/_types/CatBase'
 import { Name } from '@_types/common'
 
 /**
- * Returns information about index templates in a cluster.
+ * Get index template information.
+ * Get information about the index templates in a cluster.
  * You can use index templates to apply index settings and field mappings to new indices at creation.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
  * @rest_spec_name cat.templates

diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts
@@ -22,7 +22,8 @@ import { Names } from '@_types/common'
 import { TimeUnit } from '@_types/Time'
 
 /**
- * Returns thread pool statistics for each node in a cluster.
+ * Get thread pool statistics.
+ * Get thread pool statistics for each node in a cluster.
  * Returned information includes all built-in thread pools and custom thread pools.
  * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
  * @rest_spec_name cat.thread_pool

diff --git a/specification/cat/transforms/CatTransformsRequest.ts b/specification/cat/transforms/CatTransformsRequest.ts
@@ -23,8 +23,8 @@ import { integer } from '@_types/Numeric'
 import { TimeUnit } from '@_types/Time'
 
 /**
- * Get transforms.
- * Returns configuration and usage information about transforms.
+ * Get transform information.
+ * Get configuration and usage information about transforms.
  *
  * CAT APIs are only intended for human consumption using the Kibana
  * console or command line. They are not intended for use by applications. For