Skip to content

Commit 54b6881

Browse files
authored
generalize refs to APIs (#2761)
1 parent c3c558a commit 54b6881

File tree

9 files changed

+9
-9
lines changed

9 files changed

+9
-9
lines changed

specification/cat/aliases/CatAliasesRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { ExpandWildcards, Names } from '@_types/common'
2525
* Retrieves the cluster’s index aliases, including filter and routing information.
2626
* The API does not return data stream aliases.
2727
*
28-
* 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 /_alias endpoints.
28+
* 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.
2929
* @rest_spec_name cat.aliases
3030
* @availability stack stability=stable
3131
* @availability serverless stability=stable visibility=public

specification/cat/component_templates/CatComponentTemplatesRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { CatRequestBase } from '@cat/_types/CatBase'
2525
* Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
2626
*
2727
* CAT APIs are only intended for human consumption using the command line or Kibana console.
28-
* They are not intended for use by applications. For application consumption, use the /_component_template endpoints.
28+
* They are not intended for use by applications. For application consumption, use the get component template API.
2929
* @rest_spec_name cat.component_templates
3030
* @availability stack since=5.1.0 stability=stable
3131
* @availability serverless stability=stable visibility=public

specification/cat/count/CatCountRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { Indices } from '@_types/common'
2626
* The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
2727
*
2828
* CAT APIs are only intended for human consumption using the command line or Kibana console.
29-
* They are not intended for use by applications. For application consumption, use /_count endpoints.
29+
* They are not intended for use by applications. For application consumption, use the count API.
3030
* @rest_spec_name cat.count
3131
* @availability stack stability=stable
3232
* @availability serverless stability=stable visibility=public

specification/cat/indices/CatIndicesRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { TimeUnit } from '@_types/Time'
3333
* - total store size of all shards, including shard replicas
3434
*
3535
* 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.
36-
* To get an accurate count of Elasticsearch documents, use the /_cat/count or _count endpoints.
36+
* To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
3737
*
3838
* CAT APIs are only intended for human consumption using the command line or Kibana console.
3939
* They are not intended for use by applications. For application consumption, use an index endpoint.

specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { Duration } from '@_types/Time'
2727
*
2828
* CAT APIs are only intended for human consumption using the Kibana
2929
* console or command line. They are not intended for use by applications. For
30-
* application consumption, use the /_ml/data_frame/analytics endpoints.
30+
* application consumption, use the get data frame analytics jobs statistics API.
3131
*
3232
* @rest_spec_name cat.ml_data_frame_analytics
3333
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_datafeeds/CatDatafeedsRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import { TimeUnit } from '@_types/Time'
3030
*
3131
* CAT APIs are only intended for human consumption using the Kibana
3232
* console or command line. They are not intended for use by applications. For
33-
* application consumption, use the /_ml/datafeeds endpoints.
33+
* application consumption, use the get datafeed statistics API.
3434
*
3535
* @rest_spec_name cat.ml_datafeeds
3636
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_jobs/CatJobsRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import { TimeUnit } from '@_types/Time'
3030
*
3131
* CAT APIs are only intended for human consumption using the Kibana
3232
* console or command line. They are not intended for use by applications. For
33-
* application consumption, use the /_ml/anomaly_detectors endpoints.
33+
* application consumption, use the get anomaly detection job statistics API.
3434
*
3535
* @rest_spec_name cat.ml_jobs
3636
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_trained_models/CatTrainedModelsRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { integer } from '@_types/Numeric'
2727
*
2828
* CAT APIs are only intended for human consumption using the Kibana
2929
* console or command line. They are not intended for use by applications. For
30-
* application consumption, use the /_ml/trained_models endpoints.
30+
* application consumption, use the get trained models statistics API.
3131
*
3232
* @rest_spec_name cat.ml_trained_models
3333
* @availability stack since=7.7.0 stability=stable

specification/cat/transforms/CatTransformsRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { Duration, TimeUnit } from '@_types/Time'
2828
*
2929
* CAT APIs are only intended for human consumption using the Kibana
3030
* console or command line. They are not intended for use by applications. For
31-
* application consumption, use the /_transform endpoints.
31+
* application consumption, use the get transform statistics API.
3232
*
3333
* @rest_spec_name cat.transforms
3434
* @availability stack since=7.7.0 stability=stable

0 commit comments

Comments
 (0)