From 264ecc96c0db6ce7304482b0a5486f5e3d4b5a6a Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Thu, 1 Aug 2024 13:18:52 -0400 Subject: [PATCH] generalize refs to APIs --- specification/cat/aliases/CatAliasesRequest.ts | 2 +- .../cat/component_templates/CatComponentTemplatesRequest.ts | 2 +- specification/cat/count/CatCountRequest.ts | 2 +- specification/cat/indices/CatIndicesRequest.ts | 2 +- .../cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts | 2 +- specification/cat/ml_datafeeds/CatDatafeedsRequest.ts | 2 +- specification/cat/ml_jobs/CatJobsRequest.ts | 2 +- specification/cat/ml_trained_models/CatTrainedModelsRequest.ts | 2 +- specification/cat/transforms/CatTransformsRequest.ts | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index 7aa19281f0..91c8ccd773 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -25,7 +25,7 @@ import { ExpandWildcards, Names } from '@_types/common' * Retrieves the cluster’s index aliases, including filter and routing information. * The API does not return data stream aliases. * - * 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. + * 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. * @rest_spec_name cat.aliases * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cat/component_templates/CatComponentTemplatesRequest.ts b/specification/cat/component_templates/CatComponentTemplatesRequest.ts index c63af3a746..080da43547 100644 --- a/specification/cat/component_templates/CatComponentTemplatesRequest.ts +++ b/specification/cat/component_templates/CatComponentTemplatesRequest.ts @@ -25,7 +25,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' * 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. - * They are not intended for use by applications. For application consumption, use the /_component_template endpoints. + * 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 diff --git a/specification/cat/count/CatCountRequest.ts b/specification/cat/count/CatCountRequest.ts index c9d4e138e3..a8d7b71e24 100644 --- a/specification/cat/count/CatCountRequest.ts +++ b/specification/cat/count/CatCountRequest.ts @@ -26,7 +26,7 @@ import { Indices } from '@_types/common' * 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. - * They are not intended for use by applications. For application consumption, use /_count endpoints. + * They are not intended for use by applications. For application consumption, use the count API. * @rest_spec_name cat.count * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 7c38b104ef..5c95f1bbb2 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -33,7 +33,7 @@ import { TimeUnit } from '@_types/Time' * - 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 endpoints. + * To get an accurate count of Elasticsearch documents, use the cat count or count APIs. * * 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 an index endpoint. diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index 16627a2f34..2ac8d1bfcb 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -27,7 +27,7 @@ import { Duration } from '@_types/Time' * * 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 /_ml/data_frame/analytics endpoints. + * application consumption, use the get data frame analytics jobs statistics API. * * @rest_spec_name cat.ml_data_frame_analytics * @availability stack since=7.7.0 stability=stable diff --git a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts index e0aa1f7ed8..738b6868cb 100644 --- a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts +++ b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts @@ -30,7 +30,7 @@ import { TimeUnit } from '@_types/Time' * * 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 /_ml/datafeeds endpoints. + * application consumption, use the get datafeed statistics API. * * @rest_spec_name cat.ml_datafeeds * @availability stack since=7.7.0 stability=stable diff --git a/specification/cat/ml_jobs/CatJobsRequest.ts b/specification/cat/ml_jobs/CatJobsRequest.ts index 917ab9d32f..5d15571bbe 100644 --- a/specification/cat/ml_jobs/CatJobsRequest.ts +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -30,7 +30,7 @@ import { TimeUnit } from '@_types/Time' * * 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 /_ml/anomaly_detectors endpoints. + * application consumption, use the get anomaly detection job statistics API. * * @rest_spec_name cat.ml_jobs * @availability stack since=7.7.0 stability=stable diff --git a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index 9f31f533f7..b0f4d40151 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -27,7 +27,7 @@ import { integer } from '@_types/Numeric' * * 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 /_ml/trained_models endpoints. + * application consumption, use the get trained models statistics API. * * @rest_spec_name cat.ml_trained_models * @availability stack since=7.7.0 stability=stable diff --git a/specification/cat/transforms/CatTransformsRequest.ts b/specification/cat/transforms/CatTransformsRequest.ts index bd48167066..6cf7b80e5c 100644 --- a/specification/cat/transforms/CatTransformsRequest.ts +++ b/specification/cat/transforms/CatTransformsRequest.ts @@ -28,7 +28,7 @@ import { Duration, TimeUnit } from '@_types/Time' * * 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 /_transform endpoints. + * application consumption, use the get transform statistics API. * * @rest_spec_name cat.transforms * @availability stack since=7.7.0 stability=stable