More edits

specification/_doc_ids/table.csv

@@ -28,6 +28,7 @@ calendar-and-fixed-intervals,https://www.elastic.co/guide/en/elasticsearch/refer
 cat-alias,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html
 cat-allocation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html
 cat-anomaly-detectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html
+cat-component-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-component-templates.html
 cat-count,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html
 cat-datafeeds,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html
 cat-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html

specification/cat/aliases/CatAliasesRequest.ts

@@ -53,12 +53,12 @@ export interface Request extends CatRequestBase {
     /**
      * The type of index that wildcard patterns can match.
      * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-     * It supports comma-separated values, such as `open,hidden`. 
+     * It supports comma-separated values, such as `open,hidden`.
      */
     expand_wildcards?: ExpandWildcards
     /**
      * The period to wait for a connection to the master node.
-     * If the master node is not available before the timeout expires, the request fails and returns an error. 
+     * If the master node is not available before the timeout expires, the request fails and returns an error.
      * To indicated that the request should never timeout, you can set it to `-1`.
      * @server_default 30s
      */

specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml

@@ -6,4 +6,4 @@ description: >
 # response_code: 200
 value: |-
   shards shards.undesired write_load.forecast disk.indices.forecast disk.indices disk.used disk.avail disk.total disk.percent host      ip        node    node.role
-       1                0                 0.0                  260b         260b    47.3gb     43.4gb    100.7gb           46 127.0.0.1 127.0.0.1 CSUXak2 himrst
+       1                0                 0.0                  260b         260b    47.3gb     43.4gb    100.7gb           46 127.0.0.1 127.0.0.1 CSUXak2 himrst

specification/cat/component_templates/CatComponentTemplatesRequest.ts

@@ -22,15 +22,17 @@ import { Duration } from '@_types/Time'
 
 /**
  * Get component templates.
- * Returns information about component templates in a cluster.
+ *
+ * Get information about component templates in a cluster.
  * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
  *
- * CAT APIs are only intended for human consumption using the command line or Kibana console.
+ * 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.
  * @rest_spec_name cat.component_templates
  * @availability stack since=5.1.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor
+ * @doc_id cat-component-templates
  */
 export interface Request extends CatRequestBase {
   urls: [
@@ -44,7 +46,10 @@ export interface Request extends CatRequestBase {
     }
   ]
   path_parts: {
-    /** The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. */
+    /**
+     * The name of the component template.
+     * It accepts wildcard expressions.
+     * If it is omitted, all component templates are returned. */
     name?: string
   }
   query_parameters: {
@@ -57,7 +62,7 @@ export interface Request extends CatRequestBase {
      */
     local?: boolean
     /**
-     * Period to wait for a connection to the master node.
+     * The period to wait for a connection to the master node.
      * @server_default 30s
      */
     master_timeout?: Duration

specification/cat/count/CatCountRequest.ts

@@ -22,10 +22,11 @@ import { Indices } from '@_types/common'
 
 /**
  * Get a document count.
- * Provides quick access to a document count for a data stream, an index, or an entire cluster.
+ *
+ * Get quick access to a document count for a data stream, an index, or an entire cluster.
  * The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
  *
- * CAT APIs are only intended for human consumption using the command line or Kibana console.
+ * 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.
  * @rest_spec_name cat.count
  * @availability stack stability=stable
@@ -46,8 +47,9 @@ export interface Request extends CatRequestBase {
   ]
   path_parts: {
     /**
-     * Comma-separated list of data streams, indices, and aliases used to limit the request.
-     * Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
+     * A comma-separated list of data streams, indices, and aliases used to limit the request.
+     * It supports wildcards (`*`).
+     * To target all data streams and indices, omit this parameter or use `*` or `_all`.
      */
     index?: Indices
   }

specification/cat/fielddata/CatFielddataRequest.ts

@@ -22,7 +22,9 @@ import { Bytes, Fields } from '@_types/common'
 
 /**
  * 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

specification/cat/health/CatHealthRequest.ts

@@ -22,7 +22,8 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * Get the cluster health status.
- * IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.
+ *
+ * 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:

specification/cat/help/CatHelpRequest.ts

@@ -19,7 +19,8 @@
 
 /**
  * Get CAT help.
- * Returns help for the CAT APIs.
+ *
+ * Get help for the CAT APIs.
  * @rest_spec_name cat.help
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=public

specification/cat/indices/CatIndicesRequest.ts

@@ -23,7 +23,8 @@ import { Duration, TimeUnit } from '@_types/Time'
 
 /**
  * Get index information.
- * Returns high-level information about indices in a cluster, including backing indices for data streams.
+ *
+ * Get high-level information about indices in a cluster, including backing indices for data streams.
  *
  * Use this request to get the following information for each index in a cluster:
  * - shard count

specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml

@@ -6,4 +6,4 @@ description: >
 value: |-
   health status index            uuid                   pri rep docs.count docs.deleted store.size pri.store.size dataset.size
   yellow open   my-index-000001  u8FNjxh8Rfy_awN11oDKYQ   1   1       1200            0     88.1kb         88.1kb       88.1kb
-  green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0       260b           260b         260b
+  green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0       260b           260b         260b

specification/cat/master/CatMasterRequest.ts

@@ -22,7 +22,9 @@ import { Duration } from '@_types/Time'
 
 /**
  * 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

specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml

@@ -5,4 +5,4 @@ description: >
 # response_code:
 value: |-
   id                     host      ip        node
-  YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2
+  YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2

specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts

@@ -23,9 +23,10 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * Get data frame analytics jobs.
- * Returns configuration and usage information about data frame analytics jobs.
  *
- * CAT APIs are only intended for human consumption using the Kibana
+ * Get 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.
  *

specification/cat/ml_datafeeds/CatDatafeedsRequest.ts

@@ -23,12 +23,13 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * Get datafeeds.
- * Returns configuration and usage information about datafeeds.
+ *
+ * Get 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.
  *
- * CAT APIs are only intended for human consumption using the Kibana
+ * 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.
  *

specification/cat/ml_jobs/CatJobsRequest.ts

@@ -23,12 +23,13 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * Get anomaly detection jobs.
- * Returns configuration and usage information for anomaly detection jobs.
+ *
+ * Get 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.
  *
- * CAT APIs are only intended for human consumption using the Kibana
+ * 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.
  *

specification/cat/ml_trained_models/CatTrainedModelsRequest.ts

@@ -24,9 +24,10 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * Get trained models.
- * Returns configuration and usage information about inference trained models.
  *
- * CAT APIs are only intended for human consumption using the Kibana
+ * Get 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.
  *

specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml

@@ -6,4 +6,4 @@ value: |-
   id                           created_by operations license  create_time              version
   ddddd-1580216177138              _xpack 196        PLATINUM 2020-01-28T12:56:17.138Z 8.0.0
   flight-regress-1580215685537     _xpack 102        PLATINUM 2020-01-28T12:48:05.537Z 8.0.0
-  lang_ident_model_1               _xpack 39629      BASIC    2019-12-05T12:28:34.594Z 7.6.0
+  lang_ident_model_1               _xpack 39629      BASIC    2019-12-05T12:28:34.594Z 7.6.0

specification/cat/nodeattrs/CatNodeAttributesRequest.ts

@@ -22,6 +22,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * 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

specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml

@@ -6,4 +6,4 @@ description: >
 # response_code: 200
 value: |-
   name    pid   attr     value
-  node-0 19566 testattr test
+  node-0 19566 testattr test

specification/cat/nodes/CatNodesRequest.ts

@@ -23,6 +23,7 @@ import { Duration, TimeUnit } from '@_types/Time'
 
 /**
  * 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

specification/cat/pending_tasks/CatPendingTasksRequest.ts

@@ -22,6 +22,7 @@ import { Duration, TimeUnit } from '@_types/Time'
 
 /**
  * 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

specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml

@@ -11,4 +11,4 @@ value: |-
         1688       816ms HIGH     update-mapping [foo][t]
         1689       802ms HIGH     update-mapping [foo][t]
         1690       787ms HIGH     update-mapping [foo][t]
-        1691       773ms HIGH     update-mapping [foo][t]
+        1691       773ms HIGH     update-mapping [foo][t]

specification/cat/plugins/CatPluginsRequest.ts

@@ -22,6 +22,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * 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

specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml

@@ -18,4 +18,4 @@ value: |-
   U7321H6 mapper-annotated-text   8.17.0 The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.
   U7321H6 mapper-murmur3          8.17.0 The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.
   U7321H6 mapper-size             8.17.0 The Mapper Size plugin allows document to record their uncompressed size at index time.
-  U7321H6 store-smb               8.17.0 The Store SMB plugin adds support for SMB stores.
+  U7321H6 store-smb               8.17.0 The Store SMB plugin adds support for SMB stores.

specification/cat/recovery/CatRecoveryRequest.ts

@@ -23,6 +23,7 @@ import { TimeUnit } from '@_types/Time'
 
 /**
  * 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.

specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml

@@ -8,4 +8,4 @@ description: >
 # response_code: 200
 value: |-
   i               s t      ty   st    shost       thost       f     fp      b  bp
-  my-index-000001 0 1252ms peer done  192.168.1.1 192.168.1.2 0     100.0%  0b 100.0%
+  my-index-000001 0 1252ms peer done  192.168.1.1 192.168.1.2 0     100.0%  0b 100.0%

specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml

@@ -7,4 +7,4 @@ description: >
 # response_code: 200
 value: |-
   i               s t      ty       st    rep     snap   f  fp   b     bp
-  my-index-000001 0 1978ms snapshot done  my-repo snap-1 79 8.0% 12086 9.0%
+  my-index-000001 0 1978ms snapshot done  my-repo snap-1 79 8.0% 12086 9.0%

specification/cat/repositories/CatRepositoriesRequest.ts

@@ -22,6 +22,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * 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

specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml

@@ -6,4 +6,4 @@ description: >
 value: |-
   id    type
   repo1   fs
-  repo2   s3
+  repo2   s3

specification/cat/segments/CatSegmentsRequest.ts

@@ -23,6 +23,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * 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.

specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml

@@ -6,4 +6,4 @@ description: >
 value: |-
   index shard prirep ip        segment generation docs.count docs.deleted size size.memory committed searchable version compound
   test  0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   true
-  test1 0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   true
+  test1 0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   true

specification/cat/shards/CatShardsRequest.ts

@@ -23,6 +23,7 @@ import { Duration, TimeUnit } from '@_types/Time'
 
 /**
  * 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.

specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml

@@ -4,4 +4,4 @@ description: >
 # type: response
 # response_code: 200
 value: |-
-  my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA
+  my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA

specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml

@@ -5,4 +5,4 @@ description: >
 # type: response
 # response_code: 200
 value: |-
-  my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA
+  my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA

specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml

@@ -5,4 +5,4 @@ description: >
 # type: response
 # response_code: 200
 value: |-
-  my-index-000001 0 p RELOCATING 3014 31.1mb 192.168.56.10 H5dfFeA -> -> 192.168.56.30 bGG90GE
+  my-index-000001 0 p RELOCATING 3014 31.1mb 192.168.56.10 H5dfFeA -> -> 192.168.56.30 bGG90GE

specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml

@@ -7,4 +7,4 @@ description: >
 # response_code: 200
 value: |-
   my-index-000001 0 p STARTED      3014 31.1mb 192.168.56.10 H5dfFeA
-  my-index-000001 0 r INITIALIZING    0 14.3mb 192.168.56.30 bGG90GE
+  my-index-000001 0 r INITIALIZING    0 14.3mb 192.168.56.30 bGG90GE

specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml

@@ -8,4 +8,4 @@ value: |-
   my-index-000001 0 p STARTED    3014 31.1mb 192.168.56.10 H5dfFeA
   my-index-000001 0 r STARTED    3014 31.1mb 192.168.56.30 bGG90GE
   my-index-000001 0 r STARTED    3014 31.1mb 192.168.56.20 I8hydUG
-  my-index-000001 0 r UNASSIGNED ALLOCATION_FAILED
+  my-index-000001 0 r UNASSIGNED ALLOCATION_FAILED

specification/cat/snapshots/CatSnapshotsRequest.ts

@@ -22,7 +22,8 @@ import { Names } from '@_types/common'
 import { Duration, TimeUnit } from '@_types/Time'
 
 /**
- * Get snapshot information
+ * 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.

specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml

@@ -6,4 +6,4 @@ description: >
 value: |-
   id     repository status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
   snap1  repo1      FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
-  snap2  repo1      SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10
+  snap2  repo1      SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10