1
0
Эх сурвалжийг харах

[DOCS] Adds disclaimer to cat APIs (#83382)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
István Zoltán Szabó 3 жил өмнө
parent
commit
a1d9d04c0e

+ 7 - 0
docs/reference/cat/alias.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat aliases</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or the 
+{kib} console. They are _not_ intended for use by applications. For application 
+consumption, use the <<aliases,aliases API>>.
+====
+
 Retrieves the cluster's <<aliases,index aliases>>, including filter and routing
 information. The API does not return data stream aliases.
 

+ 5 - 0
docs/reference/cat/allocation.asciidoc

@@ -4,6 +4,11 @@
 <titleabbrev>cat allocation</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications.
+====
 
 Provides a snapshot of the number of shards allocated to each data node
 and their disk space.

+ 8 - 0
docs/reference/cat/anomaly-detectors.asciidoc

@@ -5,6 +5,14 @@
 <titleabbrev>cat anomaly detectors</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the 
+<<ml-get-job-stats,get anomaly detection job statistics API>>.
+====
+
 Returns configuration and usage information about {anomaly-jobs}.
 
 [[cat-anomaly-detectors-request]]

+ 7 - 0
docs/reference/cat/count.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat count</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<search-count,count API>>.
+====
+
 Provides quick access to a document count for a data stream, an index, or an
 entire cluster.
 

+ 7 - 0
docs/reference/cat/datafeeds.asciidoc

@@ -5,6 +5,13 @@
 <titleabbrev>cat {dfeeds}</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<ml-get-datafeed-stats,get datafeed statistics API>>.
+====
+
 Returns configuration and usage information about {dfeeds}.
 
 [[cat-datafeeds-request]]

+ 8 - 0
docs/reference/cat/dataframeanalytics.asciidoc

@@ -5,6 +5,14 @@
 <titleabbrev>cat {dfanalytics}</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the 
+<<get-dfanalytics-stats,get data frame analytics jobs statistics API>>.
+====
+
 Returns configuration and usage information about {dfanalytics-jobs}.
 
 

+ 7 - 0
docs/reference/cat/fielddata.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat fielddata</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-stats,nodes stats API>>.
+====
+
 Returns the amount of heap memory currently used by the
 <<modules-fielddata, field data cache>> on every data node in the cluster.
 

+ 7 - 0
docs/reference/cat/health.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat health</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-health,cluster health API>>.
+====
+
 Returns the health status of a cluster, similar to the <<cluster-health,cluster
 health>> API.
 

+ 7 - 0
docs/reference/cat/indices.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat indices</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<indices-get-index,get index API>>.
+====
+
 Returns high-level information about indices in a cluster, including backing
 indices for data streams.
 

+ 7 - 0
docs/reference/cat/master.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat master</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-info,nodes info API>>.
+====
+
 Returns information about the master node, including the ID, bound IP address,
 and name.
 

+ 7 - 0
docs/reference/cat/nodeattrs.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat nodeattrs</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-info,nodes info API>>.
+====
+
 Returns information about custom node attributes.
 
 [[cat-nodeattrs-api-request]]

+ 7 - 0
docs/reference/cat/nodes.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat nodes</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-info,nodes info API>>.
+====
+
 Returns information about a cluster's nodes.
 
 [[cat-nodes-api-request]]

+ 7 - 0
docs/reference/cat/pending_tasks.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat pending tasks</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-pending,pending cluster tasks API>>.
+====
+
 Returns cluster-level changes that have not yet been executed, similar to the
 <<cluster-pending, pending cluster tasks>> API.
 

+ 8 - 0
docs/reference/cat/plugins.asciidoc

@@ -4,6 +4,14 @@
 <titleabbrev>cat plugins</titleabbrev>
 ++++
 
+
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-info,nodes info API>>.
+====
+
 Returns a list of plugins running on each node of a cluster.
 
 

+ 6 - 0
docs/reference/cat/recovery.asciidoc

@@ -4,6 +4,12 @@
 <titleabbrev>cat recovery</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<indices-recovery,index recovery API>>.
+====
 
 Returns information about ongoing and completed shard recoveries,
 similar to the <<indices-recovery, index recovery>> API.

+ 7 - 0
docs/reference/cat/repositories.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat repositories</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<get-snapshot-repo-api,get snapshot repository API>>.
+====
+
 Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
 
 

+ 7 - 0
docs/reference/cat/segments.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat segments</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<indices-segments,index segments API>>.
+====
+
 Returns low-level information about the https://lucene.apache.org/core/[Lucene]
 segments in index shards, similar to the <<indices-segments, indices segments>>
 API.

+ 6 - 0
docs/reference/cat/shards.asciidoc

@@ -4,6 +4,12 @@
 <titleabbrev>cat shards</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications.
+====
+
 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.

+ 7 - 0
docs/reference/cat/snapshots.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat snapshots</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<get-snapshot-api,get snapshot API>>.
+====
+
 Returns information about the <<modules-snapshots,snapshots>> stored in one or
 more repositories. A snapshot is a backup of an index or running {es} cluster.
 

+ 7 - 0
docs/reference/cat/tasks.asciidoc

@@ -6,6 +6,13 @@
 
 beta::["The cat task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.",{es-issue}51628]
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<tasks,task management API>>.
+====
+
 Returns information about tasks currently executing in the cluster,
 similar to the <<tasks,task management>> API.
 

+ 7 - 0
docs/reference/cat/templates.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat templates</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<indices-get-template,get index template API>>.
+====
+
 Returns information about <<index-templates,index templates>> in a cluster.
 You can use index templates to apply <<index-modules-settings,index settings>>
 and <<mapping,field mappings>> to new indices at creation.

+ 7 - 0
docs/reference/cat/thread_pool.asciidoc

@@ -4,6 +4,13 @@
 <titleabbrev>cat thread pool</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<cluster-nodes-info,nodes info API>>.
+====
+
 Returns thread pool statistics for each node in a cluster. Returned information
 includes all <<modules-threadpool,built-in thread pools>> and custom thread
 pools.

+ 7 - 0
docs/reference/cat/trainedmodel.asciidoc

@@ -5,6 +5,13 @@
 <titleabbrev>cat trained model</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<get-trained-models,get trained models API>>.
+====
+
 Returns configuration and usage information about {infer} trained models.
 
 

+ 7 - 0
docs/reference/cat/transforms.asciidoc

@@ -5,6 +5,13 @@
 <titleabbrev>cat transforms</titleabbrev>
 ++++
 
+[IMPORTANT]
+====
+cat APIs are only intended for human consumption using the command line or {kib} 
+console. They are _not_ intended for use by applications. For application 
+consumption, use the <<get-transform,get transforms API>>.
+====
+
 Returns configuration and usage information about {transforms}.
 
 [[cat-transforms-api-request]]