Skip to content

Commit c44074f

Browse files
authored
Clean up markdown in spec (#2746)
1 parent 7548143 commit c44074f

File tree

12 files changed

+81
-86
lines changed

12 files changed

+81
-86
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 23 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/cat/aliases/CatAliasesRequest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import { ExpandWildcards, Names } from '@_types/common'
2424
* Get aliases.
2525
* Retrieves the cluster’s index aliases, including filter and routing information.
2626
* The API does not return data stream aliases.
27-
* > info
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](#endpoint-alias).
27+
*
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.
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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ import { CatRequestBase } from '@cat/_types/CatBase'
2323
* Get component templates.
2424
* Returns information about component templates in a cluster.
2525
* Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
26-
* > info
27-
* > 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](#endpoint-component-template).
26+
*
27+
* 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.
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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ import { Indices } from '@_types/common'
2424
* Get a document count.
2525
* Provides quick access to a document count for a data stream, an index, or an entire cluster.n/
2626
* The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
27-
* > info
28-
* > 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 [the /_count endpoints](#endpoint-count).
27+
*
28+
* 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.
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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ import { TimeUnit } from '@_types/Time'
2424
/**
2525
* Get index information.
2626
* Returns high-level information about indices in a cluster, including backing indices for data streams.
27-
* > info
28-
* > 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 an index endpoint.
3027
*
3128
* Use this request to get the following information for each index in a cluster:
3229
* - shard count
@@ -36,7 +33,10 @@ import { TimeUnit } from '@_types/Time'
3633
* - total store size of all shards, including shard replicas
3734
*
3835
* 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.
39-
* To get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.
36+
* To get an accurate count of Elasticsearch documents, use the /_cat/count or _count endpoints.
37+
*
38+
* CAT APIs are only intended for human consumption using the command line or Kibana console.
39+
* They are not intended for use by applications. For application consumption, use an index endpoint.
4040
* @rest_spec_name cat.indices
4141
* @availability stack stability=stable
4242
* @availability serverless stability=stable visibility=public

specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,9 @@ import { Duration } from '@_types/Time'
2525
* Get data frame analytics jobs.
2626
* Returns configuration and usage information about data frame analytics jobs.
2727
*
28-
* > info
29-
* > CAT APIs are only intended for human consumption using the Kibana
28+
* CAT APIs are only intended for human consumption using the Kibana
3029
* console or command line. They are not intended for use by applications. For
31-
* application consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).
30+
* application consumption, use the /_ml/data_frame/analytics endpoints.
3231
*
3332
* @rest_spec_name cat.ml_data_frame_analytics
3433
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_datafeeds/CatDatafeedsRequest.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ import { TimeUnit } from '@_types/Time'
2828
* If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
2929
* cluster privileges to use this API.
3030
*
31-
* > info
32-
* > CAT APIs are only intended for human consumption using the Kibana
31+
* CAT APIs are only intended for human consumption using the Kibana
3332
* console or command line. They are not intended for use by applications. For
34-
* application consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).
33+
* application consumption, use the /_ml/datafeeds endpoints.
3534
*
3635
* @rest_spec_name cat.ml_datafeeds
3736
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_jobs/CatJobsRequest.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ import { TimeUnit } from '@_types/Time'
2828
* If the Elasticsearch security features are enabled, you must have `monitor_ml`,
2929
* `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.
3030
*
31-
* > info
32-
* > CAT APIs are only intended for human consumption using the Kibana
31+
* CAT APIs are only intended for human consumption using the Kibana
3332
* console or command line. They are not intended for use by applications. For
34-
* application consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).
33+
* application consumption, use the /_ml/anomaly_detectors endpoints.
3534
*
3635
* @rest_spec_name cat.ml_jobs
3736
* @availability stack since=7.7.0 stability=stable

specification/cat/ml_trained_models/CatTrainedModelsRequest.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,9 @@ import { integer } from '@_types/Numeric'
2525
* Get trained models.
2626
* Returns configuration and usage information about inference trained models.
2727
*
28-
* > info
29-
* > CAT APIs are only intended for human consumption using the Kibana
28+
* CAT APIs are only intended for human consumption using the Kibana
3029
* console or command line. They are not intended for use by applications. For
31-
* application consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).
30+
* application consumption, use the /_ml/trained_models endpoints.
3231
*
3332
* @rest_spec_name cat.ml_trained_models
3433
* @availability stack since=7.7.0 stability=stable

specification/cat/transforms/CatTransformsRequest.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ import { Duration, TimeUnit } from '@_types/Time'
2626
* Get transforms.
2727
* Returns configuration and usage information about transforms.
2828
*
29-
* > info
30-
* > CAT APIs are only intended for human consumption using the Kibana
29+
* CAT APIs are only intended for human consumption using the Kibana
3130
* console or command line. They are not intended for use by applications. For
32-
* application consumption, use [the /_transform endpoints](#endpoint-transform).
31+
* application consumption, use the /_transform endpoints.
3332
*
3433
* @rest_spec_name cat.transforms
3534
* @availability stack since=7.7.0 stability=stable

0 commit comments

Comments
 (0)