diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 1ef67f9210..23a79796cb 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -912,8 +912,8 @@ "tags": [ "cat" ], - "summary": "Provides a snapshot of the number of shards allocated to each data node and their disk space", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "summary": "Get shard allocation information", + "description": "Get a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "operationId": "cat-allocation", "parameters": [ { @@ -935,8 +935,8 @@ "tags": [ "cat" ], - "summary": "Provides a snapshot of the number of shards allocated to each data node and their disk space", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "summary": "Get shard allocation information", + "description": "Get a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "operationId": "cat-allocation-1", "parameters": [ { @@ -1041,8 +1041,8 @@ "tags": [ "cat" ], - "summary": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "summary": "Get field data cache information", + "description": "Get the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "operationId": "cat-fielddata", "parameters": [ { @@ -1064,8 +1064,8 @@ "tags": [ "cat" ], - "summary": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "summary": "Get field data cache information", + "description": "Get the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "operationId": "cat-fielddata-1", "parameters": [ { @@ -1090,7 +1090,7 @@ "tags": [ "cat" ], - "summary": "Returns the health status of a cluster, similar to the cluster health API", + "summary": "Get the cluster health status", "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "operationId": "cat-health", "parameters": [ @@ -1235,8 +1235,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the master node, including the ID, bound IP address, and name", - "description": "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.", + "summary": "Get master node information", + "description": "Get information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: 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.", "operationId": "cat-master", "parameters": [ { @@ -1548,8 +1548,8 @@ "tags": [ "cat" ], - "summary": "Returns information about custom node attributes", - "description": "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.", + "summary": "Get node attribute information", + "description": "Get information about custom node attributes.\nIMPORTANT: 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.", "operationId": "cat-nodeattrs", "parameters": [ { @@ -1585,8 +1585,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the nodes in a cluster", - "description": "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.", + "summary": "Get node information", + "description": "Get information about the nodes in a cluster.\nIMPORTANT: 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.", "operationId": "cat-nodes", "parameters": [ { @@ -1649,8 +1649,8 @@ "tags": [ "cat" ], - "summary": "Returns cluster-level changes that have not yet been executed", - "description": "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.", + "summary": "Get pending task information", + "description": "Get information about cluster-level changes that have not yet taken effect.\nIMPORTANT: 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.", "operationId": "cat-pending-tasks", "parameters": [ { @@ -1686,8 +1686,8 @@ "tags": [ "cat" ], - "summary": "Returns a list of plugins running on each node of a cluster", - "description": "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.", + "summary": "Get plugin information", + "description": "Get a list of plugins running on each node of a cluster.\nIMPORTANT: 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.", "operationId": "cat-plugins", "parameters": [ { @@ -1723,8 +1723,8 @@ "tags": [ "cat" ], - "summary": "Returns information about ongoing and completed shard recoveries", - "description": "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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", + "summary": "Get shard recovery information", + "description": "Get information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", "operationId": "cat-recovery", "parameters": [ { @@ -1749,8 +1749,8 @@ "tags": [ "cat" ], - "summary": "Returns information about ongoing and completed shard recoveries", - "description": "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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", + "summary": "Get shard recovery information", + "description": "Get information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", "operationId": "cat-recovery-1", "parameters": [ { @@ -1778,8 +1778,8 @@ "tags": [ "cat" ], - "summary": "Returns the snapshot repositories for a cluster", - "description": "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.", + "summary": "Get snapshot repository information", + "description": "Get a list of snapshot repositories for a cluster.\nIMPORTANT: 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.", "operationId": "cat-repositories", "responses": { "200": { @@ -1804,8 +1804,8 @@ "tags": [ "cat" ], - "summary": "Returns low-level information about the Lucene segments in index shards", - "description": "For data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", + "summary": "Get segment information", + "description": "Get low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", "operationId": "cat-segments", "parameters": [ { @@ -1827,8 +1827,8 @@ "tags": [ "cat" ], - "summary": "Returns low-level information about the Lucene segments in index shards", - "description": "For data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", + "summary": "Get segment information", + "description": "Get low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", "operationId": "cat-segments-1", "parameters": [ { @@ -1853,8 +1853,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the shards in a cluster", - "description": "For data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "summary": "Get shard information", + "description": "Get information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "operationId": "cat-shards", "parameters": [ { @@ -1873,8 +1873,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the shards in a cluster", - "description": "For data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "summary": "Get shard information", + "description": "Get information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "operationId": "cat-shards-1", "parameters": [ { @@ -1896,8 +1896,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the snapshots stored in one or more repositories", - "description": "A snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", + "summary": "Get snapshot information\n", + "description": "Get information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", "operationId": "cat-snapshots", "parameters": [ { @@ -1917,8 +1917,8 @@ "tags": [ "cat" ], - "summary": "Returns information about the snapshots stored in one or more repositories", - "description": "A snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", + "summary": "Get snapshot information\n", + "description": "Get information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", "operationId": "cat-snapshots-1", "parameters": [ { @@ -1941,8 +1941,8 @@ "tags": [ "cat" ], - "summary": "Returns information about tasks currently executing in the cluster", - "description": "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.", + "summary": "Get task information", + "description": "Get information about tasks currently running in the cluster.\nIMPORTANT: 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.", "operationId": "cat-tasks", "parameters": [ { @@ -2015,8 +2015,8 @@ "tags": [ "cat" ], - "summary": "Returns information about index templates in a cluster", - "description": "You can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", + "summary": "Get index template information", + "description": "Get information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", "operationId": "cat-templates", "parameters": [ { @@ -2036,8 +2036,8 @@ "tags": [ "cat" ], - "summary": "Returns information about index templates in a cluster", - "description": "You can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", + "summary": "Get index template information", + "description": "Get information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", "operationId": "cat-templates-1", "parameters": [ { @@ -2060,8 +2060,8 @@ "tags": [ "cat" ], - "summary": "Returns thread pool statistics for each node in a cluster", - "description": "Returned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", + "summary": "Get thread pool statistics", + "description": "Get thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", "operationId": "cat-thread-pool", "parameters": [ { @@ -2083,8 +2083,8 @@ "tags": [ "cat" ], - "summary": "Returns thread pool statistics for each node in a cluster", - "description": "Returned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", + "summary": "Get thread pool statistics", + "description": "Get thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", "operationId": "cat-thread-pool-1", "parameters": [ { @@ -2109,8 +2109,8 @@ "tags": [ "cat" ], - "summary": "Get transforms", - "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transform information", + "description": "Get configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "operationId": "cat-transforms", "parameters": [ { @@ -2145,8 +2145,8 @@ "tags": [ "cat" ], - "summary": "Get transforms", - "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transform information", + "description": "Get configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "operationId": "cat-transforms-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index cfb45060cf..65d8c8836c 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1144,8 +1144,8 @@ "tags": [ "cat" ], - "summary": "Get transforms", - "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transform information", + "description": "Get configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "operationId": "cat-transforms", "parameters": [ { @@ -1180,8 +1180,8 @@ "tags": [ "cat" ], - "summary": "Get transforms", - "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transform information", + "description": "Get configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "operationId": "cat-transforms-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index dcd12a0126..485730b2ba 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -585,7 +585,7 @@ "stability": "stable" } }, - "description": "Provides a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard allocation information.\nGet a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-allocation", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html", "name": "cat.allocation", @@ -726,7 +726,7 @@ "stability": "stable" } }, - "description": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "description": "Get field data cache information.\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "docId": "cat-fielddata", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-fielddata.html", "name": "cat.fielddata", @@ -773,7 +773,7 @@ "stability": "stable" } }, - "description": "Returns the health status of a cluster, similar to the cluster health API.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "Get the cluster health status.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "docId": "cat-health", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-health.html", "name": "cat.health", @@ -899,7 +899,7 @@ "stability": "stable" } }, - "description": "Returns information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: 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.", + "description": "Get master node information.\nGet information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: 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.", "docId": "cat-master", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-master.html", "name": "cat.master", @@ -1132,7 +1132,7 @@ "stability": "stable" } }, - "description": "Returns information about custom node attributes.\nIMPORTANT: 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.", + "description": "Get node attribute information.\nGet information about custom node attributes.\nIMPORTANT: 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.", "docId": "cat-nodeattrs", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html", "name": "cat.nodeattrs", @@ -1173,7 +1173,7 @@ "stability": "stable" } }, - "description": "Returns information about the nodes in a cluster.\nIMPORTANT: 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.", + "description": "Get node information.\nGet information about the nodes in a cluster.\nIMPORTANT: 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.", "docId": "cat-nodes", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodes.html", "name": "cat.nodes", @@ -1214,7 +1214,7 @@ "stability": "stable" } }, - "description": "Returns cluster-level changes that have not yet been executed.\nIMPORTANT: 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.", + "description": "Get pending task information.\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: 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.", "docId": "cat-pending-tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-pending-tasks.html", "name": "cat.pending_tasks", @@ -1255,7 +1255,7 @@ "stability": "stable" } }, - "description": "Returns a list of plugins running on each node of a cluster.\nIMPORTANT: 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.", + "description": "Get plugin information.\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: 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.", "docId": "cat-plugins", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-plugins.html", "name": "cat.plugins", @@ -1296,7 +1296,7 @@ "stability": "stable" } }, - "description": "Returns information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", + "description": "Get shard recovery information.\nGet information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", "docId": "cat-recovery", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-recovery.html", "name": "cat.recovery", @@ -1347,7 +1347,7 @@ "stability": "stable" } }, - "description": "Returns the snapshot repositories for a cluster.\nIMPORTANT: 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.", + "description": "Get snapshot repository information.\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: 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.", "docId": "cat-repositories", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-repositories.html", "name": "cat.repositories", @@ -1388,7 +1388,7 @@ "stability": "stable" } }, - "description": "Returns low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", + "description": "Get segment information.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", "docId": "cat-segments", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html", "name": "cat.segments", @@ -1438,7 +1438,7 @@ "stability": "stable" } }, - "description": "Returns information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard information.\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-shards", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html", "name": "cat.shards", @@ -1489,7 +1489,7 @@ "stability": "stable" } }, - "description": "Returns information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", + "description": "Get snapshot information\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", "docId": "cat-snapshots", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html", "name": "cat.snapshots", @@ -1537,7 +1537,7 @@ "stability": "experimental" } }, - "description": "Returns information about tasks currently executing in the cluster.\nIMPORTANT: 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.", + "description": "Get task information.\nGet information about tasks currently running in the cluster.\nIMPORTANT: 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.", "docId": "tasks", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "cat.tasks", @@ -1579,7 +1579,7 @@ "stability": "stable" } }, - "description": "Returns information about index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", + "description": "Get index template information.\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", "docId": "cat-templates", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html", "name": "cat.templates", @@ -1626,7 +1626,7 @@ "stability": "stable" } }, - "description": "Returns thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", + "description": "Get thread pool statistics.\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", "docId": "cat-thread-pool", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html", "name": "cat.thread_pool", @@ -1674,7 +1674,7 @@ "stability": "stable" } }, - "description": "Get transforms.\nReturns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transform information.\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "docId": "cat-transforms", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html", "name": "cat.transforms", @@ -91127,7 +91127,7 @@ "body": { "kind": "no_body" }, - "description": "Provides a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard allocation information.\nGet a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { "name": "CatRequestBase", @@ -91179,7 +91179,7 @@ } } ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L49" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L50" }, { "kind": "response", @@ -91597,7 +91597,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "description": "Get field data cache information.\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "inherits": { "type": { "name": "CatRequestBase", @@ -91648,7 +91648,7 @@ } } ], - "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L47" + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L48" }, { "kind": "response", @@ -91953,7 +91953,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the health status of a cluster, similar to the cluster health API.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "Get the cluster health status.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "inherits": { "type": { "name": "CatRequestBase", @@ -94369,7 +94369,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: 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.", + "description": "Get master node information.\nGet information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -94396,7 +94396,7 @@ } } ], - "specLocation": "cat/master/CatMasterRequest.ts#L22-L42" + "specLocation": "cat/master/CatMasterRequest.ts#L22-L43" }, { "kind": "response", @@ -96728,7 +96728,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about custom node attributes.\nIMPORTANT: 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.", + "description": "Get node attribute information.\nGet information about custom node attributes.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -96755,7 +96755,7 @@ } } ], - "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L42" + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L43" }, { "kind": "response", @@ -98302,7 +98302,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the nodes in a cluster.\nIMPORTANT: 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.", + "description": "Get node information.\nGet information about the nodes in a cluster.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -98366,7 +98366,7 @@ } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L49" + "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L50" }, { "kind": "response", @@ -98468,7 +98468,7 @@ "body": { "kind": "no_body" }, - "description": "Returns cluster-level changes that have not yet been executed.\nIMPORTANT: 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.", + "description": "Get pending task information.\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -98495,7 +98495,7 @@ } } ], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L42" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L43" }, { "kind": "response", @@ -98624,7 +98624,7 @@ "body": { "kind": "no_body" }, - "description": "Returns a list of plugins running on each node of a cluster.\nIMPORTANT: 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.", + "description": "Get plugin information.\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -98651,7 +98651,7 @@ } } ], - "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L42" + "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L43" }, { "kind": "response", @@ -99104,7 +99104,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", + "description": "Get shard recovery information.\nGet information about ongoing and completed shard recoveries.\nShard 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.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -99169,7 +99169,7 @@ } } ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L59" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L60" }, { "kind": "response", @@ -99241,7 +99241,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the snapshot repositories for a cluster.\nIMPORTANT: 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.", + "description": "Get snapshot repository information.\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -99254,7 +99254,7 @@ }, "path": [], "query": [], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L31" + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L32" }, { "kind": "response", @@ -99286,7 +99286,7 @@ "body": { "kind": "no_body" }, - "description": "Returns low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", + "description": "Get segment information.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -99338,7 +99338,7 @@ } } ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L57" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L58" }, { "kind": "response", @@ -99610,7 +99610,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard information.\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { "name": "CatRequestBase", @@ -99649,7 +99649,7 @@ } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L23-L49" + "specLocation": "cat/shards/CatShardsRequest.ts#L23-L50" }, { "kind": "response", @@ -100962,7 +100962,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", + "description": "Get snapshot information\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -101002,7 +101002,7 @@ } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L50" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L51" }, { "kind": "response", @@ -101280,7 +101280,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about tasks currently executing in the cluster.\nIMPORTANT: 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.", + "description": "Get task information.\nGet information about tasks currently running in the cluster.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -101349,7 +101349,7 @@ } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L22-L47" + "specLocation": "cat/tasks/CatTasksRequest.ts#L22-L48" }, { "kind": "response", @@ -101627,7 +101627,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", + "description": "Get index template information.\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -101667,7 +101667,7 @@ } } ], - "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L51" + "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L52" }, { "kind": "response", @@ -101797,7 +101797,7 @@ "body": { "kind": "no_body" }, - "description": "Returns thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", + "description": "Get thread pool statistics.\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: 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.", "inherits": { "type": { "name": "CatRequestBase", @@ -101849,7 +101849,7 @@ } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L56" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L57" }, { "kind": "response", @@ -102239,7 +102239,7 @@ "body": { "kind": "no_body" }, - "description": "Get transforms.\nReturns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transform information.\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "inherits": { "type": { "name": "CatRequestBase", diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index f29817b4d4..2e2beac2d5 100644 --- 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 index b237d06c84..9d71d1b339 100644 --- 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 index 6cd4151681..1d4edb593a 100644 --- 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 index 48e80f9455..488a62ba13 100644 --- 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 index 9bae2d680f..5a80ee5950 100644 --- 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 index 97d709f9c7..b3b1e0760f 100644 --- 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 index 0d316f233d..087fa59dd5 100644 --- 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 index 8a1c715d04..2a074ef589 100644 --- 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 index 666ef6a06c..2779e2efa1 100644 --- 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 index 2ce038260a..9b00a116ad 100644 --- 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 index 673b83f374..b234c1cf6b 100644 --- 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 index fa6a11f221..62409ca99e 100644 --- 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 index fa54d7e435..7373228890 100644 --- 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 index e583d4029b..94c3d93ca4 100644 --- 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 index 00a18d6492..ffb820f319 100644 --- 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 index b8046a83d4..a1b42b5bd6 100644 --- 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 index 59927c8189..0b7703cd2d 100644 --- 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