Clean up markdown in spec (#2746)

elastic · Jul 30, 2024 · c44074f · c44074f
1 parent 7548143
commit c44074f
Show file tree

Hide file tree

Showing 12 changed files with 81 additions and 86 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts
@@ -24,8 +24,8 @@ import { ExpandWildcards, Names } from '@_types/common'
  * Get aliases.
  * Retrieves the cluster’s index aliases, including filter and routing information.
  * The API does not return data stream aliases.
- * > info
- * > 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](#endpoint-alias).
+ *
+ * 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.
  * @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
@@ -23,9 +23,9 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * Get component templates.
  * Returns information about component templates in a cluster.
  * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
- * > info
- * > 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](#endpoint-component-template).
+ *
+ * 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.
  * @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
@@ -24,9 +24,9 @@ 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.n/
  * The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
- * > info
- * > 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 endpoints](#endpoint-count).
+ *
+ * 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.
  * @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
@@ -24,9 +24,6 @@ import { TimeUnit } from '@_types/Time'
 /**
  * Get index information.
  * Returns high-level information about indices in a cluster, including backing indices for data streams.
- * > info
- * > 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.
  *
  * Use this request to get the following information for each index in a cluster:
  * - shard count
@@ -36,7 +33,10 @@ 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](#operation-cat-count) or [count](#endpoint-count) endpoints.
+ * To get an accurate count of Elasticsearch documents, use the /_cat/count or _count endpoints.
+ *
+ * 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.
  * @rest_spec_name cat.indices
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=public

diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts
@@ -25,10 +25,9 @@ import { Duration } from '@_types/Time'
  * Get data frame analytics jobs.
  * Returns configuration and usage information about data frame analytics jobs.
  *
- * > info
- * > CAT APIs are only intended for human consumption using the Kibana
+ * 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](#endpoint-ml).
+ * application consumption, use the /_ml/data_frame/analytics endpoints.
  *
  * @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
@@ -28,10 +28,9 @@ import { TimeUnit } from '@_types/Time'
  * If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
  * cluster privileges to use this API.
  *
- * > info
- * > CAT APIs are only intended for human consumption using the Kibana
+ * 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](#endpoint-ml).
+ * application consumption, use the /_ml/datafeeds endpoints.
  *
  * @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
@@ -28,10 +28,9 @@ import { TimeUnit } from '@_types/Time'
  * If the Elasticsearch security features are enabled, you must have `monitor_ml`,
  * `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.
  *
- * > info
- * > CAT APIs are only intended for human consumption using the Kibana
+ * 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](#endpoint-ml).
+ * application consumption, use the /_ml/anomaly_detectors endpoints.
  *
  * @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
@@ -25,10 +25,9 @@ import { integer } from '@_types/Numeric'
  * Get trained models.
  * Returns configuration and usage information about inference trained models.
  *
- * > info
- * > CAT APIs are only intended for human consumption using the Kibana
+ * 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](#endpoint-ml).
+ * application consumption, use the /_ml/trained_models endpoints.
  *
  * @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
@@ -26,10 +26,9 @@ import { Duration, TimeUnit } from '@_types/Time'
  * Get transforms.
  * Returns configuration and usage information about transforms.
  *
- * > info
- * > CAT APIs are only intended for human consumption using the Kibana
+ * 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](#endpoint-transform).
+ * application consumption, use the /_transform endpoints.
  *
  * @rest_spec_name cat.transforms
  * @availability stack since=7.7.0 stability=stable