@elastic/elasticsearch 8.14.0 → 8.15.0

package/lib/api/api/cat.d.ts

@@ -8,183 +8,183 @@ export default class Cat {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Shows information about currently configured aliases to indices including filter and routing infos.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-alias.html | Elasticsearch API documentation}
+      * Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-alias.html | Elasticsearch API documentation}
       */
     aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAliasesResponse>;
     aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAliasesResponse, unknown>>;
     aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptions): Promise<T.CatAliasesResponse>;
     /**
-      * Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-allocation.html | Elasticsearch API documentation}
+      * Provides 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-allocation.html | Elasticsearch API documentation}
       */
     allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAllocationResponse>;
     allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAllocationResponse, unknown>>;
     allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptions): Promise<T.CatAllocationResponse>;
     /**
-      * Returns information about existing component_templates templates.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-component-templates.html | Elasticsearch API documentation}
+      * Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. 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 component template API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-component-templates.html | Elasticsearch API documentation}
       */
     componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>;
     componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatComponentTemplatesResponse, unknown>>;
     componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatComponentTemplatesResponse>;
     /**
-      * Provides quick access to the document count of the entire cluster, or individual indices.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-count.html | Elasticsearch API documentation}
+      * Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. 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 count API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-count.html | Elasticsearch API documentation}
       */
     count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatCountResponse>;
     count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatCountResponse, unknown>>;
     count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptions): Promise<T.CatCountResponse>;
     /**
-      * Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-fielddata.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-fielddata.html | Elasticsearch API documentation}
       */
     fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatFielddataResponse>;
     fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatFielddataResponse, unknown>>;
     fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptions): Promise<T.CatFielddataResponse>;
     /**
-      * Returns a concise representation of the cluster health.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-health.html | Elasticsearch API documentation}
+      * Returns the health status of a cluster, similar to the cluster health API. 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. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-health.html | Elasticsearch API documentation}
       */
     health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHealthResponse>;
     health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHealthResponse, unknown>>;
     health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptions): Promise<T.CatHealthResponse>;
     /**
       * Returns help for the Cat APIs.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat.html | Elasticsearch API documentation}
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat.html | Elasticsearch API documentation}
       */
     help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHelpResponse>;
     help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHelpResponse, unknown>>;
     help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptions): Promise<T.CatHelpResponse>;
     /**
-      * Returns information about indices: number of primaries and replicas, document counts, disk size, ...
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-indices.html | Elasticsearch API documentation}
+      * Returns high-level information about indices in a cluster, including backing indices for data streams. 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 API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-indices.html | Elasticsearch API documentation}
       */
     indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatIndicesResponse>;
     indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatIndicesResponse, unknown>>;
     indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptions): Promise<T.CatIndicesResponse>;
     /**
-      * Returns information about the master node.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-master.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-master.html | Elasticsearch API documentation}
       */
     master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMasterResponse>;
     master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMasterResponse, unknown>>;
     master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptions): Promise<T.CatMasterResponse>;
     /**
-      * Gets configuration and usage information about data frame analytics jobs.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-dfanalytics.html | Elasticsearch API documentation}
+      * Returns configuration and usage information about data frame analytics jobs. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-dfanalytics.html | Elasticsearch API documentation}
       */
     mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDataFrameAnalyticsResponse>;
     mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDataFrameAnalyticsResponse, unknown>>;
     mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.CatMlDataFrameAnalyticsResponse>;
     /**
-      * Gets configuration and usage information about datafeeds.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-datafeeds.html | Elasticsearch API documentation}
+      * Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-datafeeds.html | Elasticsearch API documentation}
       */
     mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDatafeedsResponse>;
     mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDatafeedsResponse, unknown>>;
     mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptions): Promise<T.CatMlDatafeedsResponse>;
     /**
-      * Gets configuration and usage information about anomaly detection jobs.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-anomaly-detectors.html | Elasticsearch API documentation}
+      * Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-anomaly-detectors.html | Elasticsearch API documentation}
       */
     mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlJobsResponse>;
     mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlJobsResponse, unknown>>;
     mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptions): Promise<T.CatMlJobsResponse>;
     /**
-      * Gets configuration and usage information about inference trained models.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-trained-model.html | Elasticsearch API documentation}
+      * Returns configuration and usage information about inference trained models. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-trained-model.html | Elasticsearch API documentation}
       */
     mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlTrainedModelsResponse>;
     mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlTrainedModelsResponse, unknown>>;
     mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptions): Promise<T.CatMlTrainedModelsResponse>;
     /**
-      * Returns information about custom node attributes.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodeattrs.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodeattrs.html | Elasticsearch API documentation}
       */
     nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodeattrsResponse>;
     nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodeattrsResponse, unknown>>;
     nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptions): Promise<T.CatNodeattrsResponse>;
     /**
-      * Returns basic statistics about performance of cluster nodes.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodes.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodes.html | Elasticsearch API documentation}
       */
     nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodesResponse>;
     nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodesResponse, unknown>>;
     nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptions): Promise<T.CatNodesResponse>;
     /**
-      * Returns a concise representation of the cluster pending tasks.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-pending-tasks.html | Elasticsearch API documentation}
+      * Returns cluster-level changes that have not yet been executed. 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-pending-tasks.html | Elasticsearch API documentation}
       */
     pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPendingTasksResponse>;
     pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPendingTasksResponse, unknown>>;
     pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptions): Promise<T.CatPendingTasksResponse>;
     /**
-      * Returns information about installed plugins across nodes node.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-plugins.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-plugins.html | Elasticsearch API documentation}
       */
     plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPluginsResponse>;
     plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPluginsResponse, unknown>>;
     plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptions): Promise<T.CatPluginsResponse>;
     /**
-      * Returns information about index shard recoveries, both on-going completed.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-recovery.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-recovery.html | Elasticsearch API documentation}
       */
     recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRecoveryResponse>;
     recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRecoveryResponse, unknown>>;
     recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptions): Promise<T.CatRecoveryResponse>;
     /**
-      * Returns information about snapshot repositories registered in the cluster.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-repositories.html | Elasticsearch API documentation}
+      * Returns the 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-repositories.html | Elasticsearch API documentation}
       */
     repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRepositoriesResponse>;
     repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRepositoriesResponse, unknown>>;
     repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptions): Promise<T.CatRepositoriesResponse>;
     /**
-      * Provides low-level information about the segments in the shards of an index.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-segments.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-segments.html | Elasticsearch API documentation}
       */
     segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSegmentsResponse>;
     segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSegmentsResponse, unknown>>;
     segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptions): Promise<T.CatSegmentsResponse>;
     /**
-      * Provides a detailed view of shard allocation on nodes.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-shards.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-shards.html | Elasticsearch API documentation}
       */
     shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatShardsResponse>;
     shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatShardsResponse, unknown>>;
     shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptions): Promise<T.CatShardsResponse>;
     /**
-      * Returns all snapshots in a specific repository.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-snapshots.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-snapshots.html | Elasticsearch API documentation}
       */
     snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSnapshotsResponse>;
     snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSnapshotsResponse, unknown>>;
     snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptions): Promise<T.CatSnapshotsResponse>;
     /**
-      * Returns information about the tasks currently executing on one or more nodes in the cluster.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html | Elasticsearch API documentation}
+      * Returns information about tasks currently executing 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/tasks.html | Elasticsearch API documentation}
       */
     tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTasksResponse>;
     tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTasksResponse, unknown>>;
     tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptions): Promise<T.CatTasksResponse>;
     /**
-      * Returns information about existing templates.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-templates.html | Elasticsearch API documentation}
+      * Returns information about 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-templates.html | Elasticsearch API documentation}
       */
     templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTemplatesResponse>;
     templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTemplatesResponse, unknown>>;
     templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatTemplatesResponse>;
     /**
-      * Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-thread-pool.html | Elasticsearch API documentation}
+      * Returns 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.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-thread-pool.html | Elasticsearch API documentation}
       */
     threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatThreadPoolResponse>;
     threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatThreadPoolResponse, unknown>>;
     threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptions): Promise<T.CatThreadPoolResponse>;
     /**
-      * Gets configuration and usage information about transforms.
-      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-transforms.html | Elasticsearch API documentation}
+      * Returns configuration and usage information about transforms. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
+      * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-transforms.html | Elasticsearch API documentation}
       */
     transforms(this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTransformsResponse>;
     transforms(this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTransformsResponse, unknown>>;

package/lib/api/api/cat.js

@@ -52,7 +52,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/aliases';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.aliases',
+            pathParts: {
+                name: params.name
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async allocation(params, options) {
         const acceptedPath = ['node_id'];
@@ -78,7 +84,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/allocation';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.allocation',
+            pathParts: {
+                node_id: params.node_id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async componentTemplates(params, options) {
         const acceptedPath = ['name'];
@@ -104,7 +116,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/component_templates';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.component_templates',
+            pathParts: {
+                name: params.name
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async count(params, options) {
         const acceptedPath = ['index'];
@@ -130,7 +148,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/count';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.count',
+            pathParts: {
+                index: params.index
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async fielddata(params, options) {
         const acceptedPath = ['fields'];
@@ -156,7 +180,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/fielddata';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.fielddata',
+            pathParts: {
+                fields: params.fields
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async health(params, options) {
         const acceptedPath = [];
@@ -174,7 +204,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/health';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.health'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async help(params, options) {
         const acceptedPath = [];
@@ -192,7 +225,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.help'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async indices(params, options) {
         const acceptedPath = ['index'];
@@ -218,7 +254,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/indices';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.indices',
+            pathParts: {
+                index: params.index
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async master(params, options) {
         const acceptedPath = [];
@@ -236,7 +278,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/master';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.master'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async mlDataFrameAnalytics(params, options) {
         const acceptedPath = ['id'];
@@ -262,7 +307,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/ml/data_frame/analytics';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.ml_data_frame_analytics',
+            pathParts: {
+                id: params.id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async mlDatafeeds(params, options) {
         const acceptedPath = ['datafeed_id'];
@@ -288,7 +339,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/ml/datafeeds';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.ml_datafeeds',
+            pathParts: {
+                datafeed_id: params.datafeed_id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async mlJobs(params, options) {
         const acceptedPath = ['job_id'];
@@ -314,7 +371,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/ml/anomaly_detectors';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.ml_jobs',
+            pathParts: {
+                job_id: params.job_id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async mlTrainedModels(params, options) {
         const acceptedPath = ['model_id'];
@@ -340,7 +403,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/ml/trained_models';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.ml_trained_models',
+            pathParts: {
+                model_id: params.model_id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async nodeattrs(params, options) {
         const acceptedPath = [];
@@ -358,7 +427,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/nodeattrs';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.nodeattrs'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async nodes(params, options) {
         const acceptedPath = [];
@@ -376,7 +448,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/nodes';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.nodes'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async pendingTasks(params, options) {
         const acceptedPath = [];
@@ -394,7 +469,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/pending_tasks';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.pending_tasks'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async plugins(params, options) {
         const acceptedPath = [];
@@ -412,7 +490,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/plugins';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.plugins'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async recovery(params, options) {
         const acceptedPath = ['index'];
@@ -438,7 +519,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/recovery';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.recovery',
+            pathParts: {
+                index: params.index
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async repositories(params, options) {
         const acceptedPath = [];
@@ -456,7 +543,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/repositories';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.repositories'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async segments(params, options) {
         const acceptedPath = ['index'];
@@ -482,7 +572,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/segments';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.segments',
+            pathParts: {
+                index: params.index
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async shards(params, options) {
         const acceptedPath = ['index'];
@@ -508,7 +604,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/shards';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.shards',
+            pathParts: {
+                index: params.index
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async snapshots(params, options) {
         const acceptedPath = ['repository'];
@@ -534,7 +636,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/snapshots';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.snapshots',
+            pathParts: {
+                repository: params.repository
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async tasks(params, options) {
         const acceptedPath = [];
@@ -552,7 +660,10 @@ class Cat {
         }
         const method = 'GET';
         const path = '/_cat/tasks';
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.tasks'
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async templates(params, options) {
         const acceptedPath = ['name'];
@@ -578,7 +689,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/templates';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.templates',
+            pathParts: {
+                name: params.name
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async threadPool(params, options) {
         const acceptedPath = ['thread_pool_patterns'];
@@ -604,7 +721,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/thread_pool';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.thread_pool',
+            pathParts: {
+                thread_pool_patterns: params.thread_pool_patterns
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
     async transforms(params, options) {
         const acceptedPath = ['transform_id'];
@@ -630,7 +753,13 @@ class Cat {
             method = 'GET';
             path = '/_cat/transforms';
         }
-        return await this.transport.request({ path, method, querystring, body }, options);
+        const meta = {
+            name: 'cat.transforms',
+            pathParts: {
+                transform_id: params.transform_id
+            }
+        };
+        return await this.transport.request({ path, method, querystring, body, meta }, options);
     }
 }
 exports.default = Cat;