diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index b6459eaa93b82..72f949bf11e50 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -12,7 +12,7 @@ consumption, use the <>. ==== Retrieves the cluster's <>, including filter and routing -information. The API does not return data stream aliases. +information. The API does not return <> aliases. [[cat-alias-api-request]] ==== {api-request-title} diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index 0891406d1be4b..bbd044c4b8e5e 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -7,10 +7,11 @@ [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} -console. They are _not_ intended for use by applications. +console. They are _not_ intended for use by applications. For application +consumption, use the <>. ==== -Provides a snapshot of the number of shards allocated to each data node +Provides a snapshot of the number of shards <> to each data node and their disk space. diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 3416c256881af..68d952d2a8532 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -13,7 +13,7 @@ consumption, use the <>. ==== -Returns configuration and usage information about {anomaly-jobs}. +Returns configuration and usage information about {ml-docs}/ml-ad-overview.html[{anomaly-jobs}]. [[cat-anomaly-detectors-request]] ==== {api-request-title} diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index 9b6481191e59d..506812fedabad 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns configuration and usage information about {dfeeds}. +Returns configuration and usage information about {ml-docs}/ml-ad-run-jobs.html#ml-ad-datafeeds[{dfeeds}]. [[cat-datafeeds-request]] ==== {api-request-title} diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index 4c236ecf61ffc..ed0f697c36d50 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -13,7 +13,7 @@ consumption, use the <>. ==== -Returns configuration and usage information about {dfanalytics-jobs}. +Returns configuration and usage information about {ml-docs}/ml-dfanalytics.html[{dfanalytics-jobs}]. [[cat-dfanalytics-request]] diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 64b90c4f8e353..cf1cc9f825cb2 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -11,8 +11,8 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns high-level information about indices in a cluster, including backing -indices for data streams. +Returns high-level information about <> in a cluster, including backing +indices for <>. [[cat-indices-api-request]] diff --git a/docs/reference/cat/master.asciidoc b/docs/reference/cat/master.asciidoc index 42348fc4939df..bcf2b876e4506 100644 --- a/docs/reference/cat/master.asciidoc +++ b/docs/reference/cat/master.asciidoc @@ -11,7 +11,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns information about the master node, including the ID, bound IP address, +Returns information about the <>, including the ID, bound IP address, and name. diff --git a/docs/reference/cat/nodeattrs.asciidoc b/docs/reference/cat/nodeattrs.asciidoc index 2db0c3fc20279..ff37b430956aa 100644 --- a/docs/reference/cat/nodeattrs.asciidoc +++ b/docs/reference/cat/nodeattrs.asciidoc @@ -11,7 +11,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns information about custom node attributes. +Returns information about <>. [[cat-nodeattrs-api-request]] ==== {api-request-title} diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index 5f329c00efd7f..651c4ef3c7c2a 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -13,7 +13,7 @@ They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns information about a cluster's nodes. +Returns information about a <>. [[cat-nodes-api-request]] ==== {api-request-title} diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index 5dd6cb0688145..f772cdb66d889 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -11,8 +11,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns cluster-level changes that have not yet been executed, similar to the -<> API. +Returns <> that have not yet been executed. [[cat-pending-tasks-api-request]] ==== {api-request-title} diff --git a/docs/reference/cat/plugins.asciidoc b/docs/reference/cat/plugins.asciidoc index a812556887b74..ae360862a0edb 100644 --- a/docs/reference/cat/plugins.asciidoc +++ b/docs/reference/cat/plugins.asciidoc @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns a list of plugins running on each node of a cluster. +Returns a list of <> running on each node of a cluster. [[cat-plugins-api-request]] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index c3292fc9971ee..7393a8b719089 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -11,10 +11,9 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns information about ongoing and completed shard recoveries, -similar to the <> API. +Returns information about ongoing and completed <>. -For data streams, the API returns information about the stream's backing +For <>, the API returns information about the stream's backing indices. [[cat-recovery-api-request]] diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 872af679642d0..82dc7298a0783 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -12,10 +12,9 @@ consumption, use the <>. ==== Returns low-level information about the https://lucene.apache.org/core/[Lucene] -segments in index shards, similar to the <> -API. +segments in index shards. -For data streams, the API returns information about the stream's backing +For <>, the API returns information about the stream's backing indices. [[cat-segments-api-request]] diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index a2f8541be4abc..812b946ab2c47 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -9,13 +9,16 @@ ==== cat APIs are only intended for human consumption using the command line or {kib} console. -They are _not_ intended for use by applications. +They are _not_ intended for use by applications. For application +consumption, use the <>. ==== -The `shards` command is the detailed view of what nodes contain which shards. -It will tell you if it's a primary or replica, the number of docs, the bytes it takes on disk, and the node where it's located. +The `shards` command is the detailed view of all nodes' shard <>. +It will tell you if the shard is a primary or replica, the number of docs, the +bytes it takes on disk, the node where it's located, and if the shard is +currently <>. -For data streams, the API returns information about the stream's backing indices. +For <>, the API returns information about the stream's backing indices. [[cat-shards-api-request]] ==== {api-request-title} diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 74e83525ddfe1..45c87038f5d64 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns configuration and usage information about {infer} trained models. +Returns configuration and usage information about {ml-docs}/ml-nlp-deploy-models.html[{infer} trained models]. [[cat-trained-model-request]] diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index 0d4e9b691ac5a..53f22f02fbdbf 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application consumption, use the <>. ==== -Returns configuration and usage information about {transforms}. +Returns configuration and usage information about <>. [[cat-transforms-api-request]] ==== {api-request-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc index a224f3880a1ad..0a8f1e802715e 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc @@ -7,7 +7,7 @@ Get {dfeed} statistics ++++ -Retrieves usage information for {dfeeds}. +Retrieves usage information for {ml-docs}/ml-ad-run-jobs.html#ml-ad-datafeeds[{dfeeds}]. [[ml-get-datafeed-stats-request]] == {api-request-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc index a5bd188397bb9..627109d11e11e 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc @@ -5,7 +5,7 @@ Get job statistics ++++ -Retrieves usage information for {anomaly-jobs}. +Retrieves usage information for {ml-docs}/ml-ad-overview.html[{anomaly-jobs}]. [[ml-get-job-stats-request]] == {api-request-title} diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index b193379084db1..9037819c9f236 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -6,7 +6,7 @@ Get {dfanalytics-jobs} stats ++++ -Retrieves usage information for {dfanalytics-jobs}. +Retrieves usage information for {ml-docs}/ml-dfanalytics.html[{dfanalytics-jobs}]. [[ml-get-dfanalytics-stats-request]] diff --git a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc index f203578c6f1c7..ffb46eaa1fe2e 100644 --- a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc @@ -6,7 +6,7 @@ Get trained models ++++ -Retrieves configuration information for a trained model. +Retrieves configuration information about {ml-docs}/ml-nlp-deploy-models.html[{infer} trained models]. [[ml-get-trained-models-request]]