From c3dcedf7fd7fc8a5fafcd3b58adb6df9bae9f1b2 Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Fri, 26 Jul 2024 14:38:23 -0400 Subject: [PATCH] Add further summaries (#2734) --- output/openapi/elasticsearch-openapi.json | 184 ++++++++++-------- .../elasticsearch-serverless-openapi.json | 176 +++++++++-------- output/schema/schema.json | 180 ++++++++--------- .../delete_by_query/DeleteByQueryRequest.ts | 1 + .../update_by_query/UpdateByQueryRequest.ts | 1 + .../cat/aliases/CatAliasesRequest.ts | 4 +- .../CatComponentTemplatesRequest.ts | 6 +- specification/cat/count/CatCountRequest.ts | 10 +- specification/cat/help/CatHelpRequest.ts | 2 + .../cat/indices/CatIndicesRequest.ts | 17 +- .../CatDataFrameAnalyticsRequest.ts | 6 +- .../cat/ml_datafeeds/CatDatafeedsRequest.ts | 6 +- specification/cat/ml_jobs/CatJobsRequest.ts | 6 +- .../CatTrainedModelsRequest.ts | 6 +- .../cat/transforms/CatTransformsRequest.ts | 6 +- .../DeleteEnrichPolicyRequest.ts | 1 + .../get_policy/GetEnrichPolicyRequest.ts | 1 + .../put_policy/PutEnrichPolicyRequest.ts | 1 + .../enrich/stats/EnrichStatsRequest.ts | 1 + .../IndicesGetFieldMappingRequest.ts | 1 + .../get_mapping/IndicesGetMappingRequest.ts | 1 + .../put_mapping/IndicesPutMappingRequest.ts | 1 + .../IndicesValidateQueryRequest.ts | 3 +- .../DeleteTransformRequest.ts | 1 + .../get_transform/GetTransformRequest.ts | 1 + .../GetTransformStatsRequest.ts | 1 + .../PreviewTransformRequest.ts | 3 +- .../put_transform/PutTransformRequest.ts | 1 + .../reset_transform/ResetTransformRequest.ts | 1 + .../ScheduleNowTransformRequest.ts | 3 +- .../start_transform/StartTransformRequest.ts | 1 + .../stop_transform/StopTransformRequest.ts | 1 + .../UpdateTransformRequest.ts | 1 + 33 files changed, 357 insertions(+), 278 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 3f8c0c5364..39a9d5deab 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -848,8 +848,8 @@ "tags": [ "cat.aliases" ], - "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases.\nIMPORTANT: 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.", + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -871,8 +871,8 @@ "tags": [ "cat.aliases" ], - "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases.\nIMPORTANT: 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.", + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -946,8 +946,8 @@ "tags": [ "cat.component_templates" ], - "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -965,8 +965,8 @@ "tags": [ "cat.component_templates" ], - "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -989,8 +989,8 @@ "tags": [ "cat.count" ], - "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -1007,8 +1007,8 @@ "tags": [ "cat.count" ], - "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -1135,7 +1135,8 @@ "tags": [ "cat.help" ], - "summary": "Returns help for the Cat APIs", + "summary": "Get CAT help", + "description": "Returns help for the CAT APIs.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html" }, @@ -1162,8 +1163,8 @@ "tags": [ "cat.indices" ], - "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -1200,8 +1201,8 @@ "tags": [ "cat.indices" ], - "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -1269,8 +1270,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1305,8 +1306,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1344,8 +1345,8 @@ "tags": [ "cat.ml_datafeeds" ], - "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1377,8 +1378,8 @@ "tags": [ "cat.ml_datafeeds" ], - "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1413,8 +1414,8 @@ "tags": [ "cat.ml_jobs" ], - "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1449,8 +1450,8 @@ "tags": [ "cat.ml_jobs" ], - "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1488,8 +1489,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1527,8 +1528,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -2129,8 +2130,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -2168,8 +2169,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -6977,7 +6978,8 @@ "tags": [ "delete_by_query" ], - "summary": "Deletes documents that match the specified query", + "summary": "Delete documents", + "description": "Deletes documents that match the specified query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html" }, @@ -7613,7 +7615,8 @@ "tags": [ "enrich.get_policy" ], - "summary": "Returns information about an enrich policy", + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, @@ -7634,7 +7637,8 @@ "tags": [ "enrich.put_policy" ], - "summary": "Creates an enrich policy", + "summary": "Create an enrich policy", + "description": "Creates an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html" }, @@ -7691,7 +7695,8 @@ "tags": [ "enrich.delete_policy" ], - "summary": "Deletes an existing enrich policy and its enrich index", + "summary": "Delete an enrich policy", + "description": "Deletes an existing enrich policy and its enrich index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html" }, @@ -7785,7 +7790,8 @@ "tags": [ "enrich.get_policy" ], - "summary": "Returns information about an enrich policy", + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, @@ -7803,7 +7809,8 @@ "tags": [ "enrich.stats" ], - "summary": "Returns enrich coordinator statistics and information about enrich policies that are currently executing", + "summary": "Get enrich stats", + "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html" }, @@ -13125,8 +13132,8 @@ "tags": [ "indices.get_field_mapping" ], - "summary": "Retrieves mapping definitions for one or more fields", - "description": "For data streams, the API retrieves field mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html" }, @@ -13163,8 +13170,8 @@ "tags": [ "indices.get_field_mapping" ], - "summary": "Retrieves mapping definitions for one or more fields", - "description": "For data streams, the API retrieves field mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html" }, @@ -13237,8 +13244,8 @@ "tags": [ "indices.get_mapping" ], - "summary": "Retrieves mapping definitions for one or more indices", - "description": "For data streams, the API retrieves mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, @@ -13272,8 +13279,8 @@ "tags": [ "indices.get_mapping" ], - "summary": "Retrieves mapping definitions for one or more indices", - "description": "For data streams, the API retrieves mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, @@ -13308,8 +13315,8 @@ "tags": [ "indices.put_mapping" ], - "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -13350,8 +13357,8 @@ "tags": [ "indices.put_mapping" ], - "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -15196,7 +15203,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -15253,7 +15261,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -15312,7 +15321,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -15372,7 +15382,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -34919,7 +34930,8 @@ "tags": [ "transform.get_transform" ], - "summary": "Retrieves configuration information for transforms", + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" }, @@ -34952,8 +34964,8 @@ "tags": [ "transform.put_transform" ], - "summary": "Creates a transform", - "description": "A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", + "summary": "Create a transform", + "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" }, @@ -35056,7 +35068,8 @@ "tags": [ "transform.delete_transform" ], - "summary": "Deletes a transform", + "summary": "Delete a transform", + "description": "Deletes a transform.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html" }, @@ -35124,7 +35137,8 @@ "tags": [ "transform.get_transform" ], - "summary": "Retrieves configuration information for transforms", + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" }, @@ -35156,7 +35170,8 @@ "tags": [ "transform.get_transform_stats" ], - "summary": "Retrieves usage information for transforms", + "summary": "Get transform stats", + "description": "Retrieves usage information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html" }, @@ -35249,8 +35264,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35277,8 +35292,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35307,8 +35322,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35332,8 +35347,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35359,8 +35374,8 @@ "tags": [ "transform.reset_transform" ], - "summary": "Resets a transform", - "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "summary": "Reset a transform", + "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html" }, @@ -35408,8 +35423,8 @@ "tags": [ "transform.schedule_now_transform" ], - "summary": "Schedules now a transform", - "description": "If you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "summary": "Schedule a transform to start now", + "description": "Instantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html" }, @@ -35457,8 +35472,8 @@ "tags": [ "transform.start_transform" ], - "summary": "Starts a transform", - "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "summary": "Start a transform", + "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" }, @@ -35516,7 +35531,8 @@ "tags": [ "transform.stop_transform" ], - "summary": "Stops one or more transforms", + "summary": "Stop transforms", + "description": "Stops one or more transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html" }, @@ -35604,8 +35620,8 @@ "tags": [ "transform.update_transform" ], - "summary": "Updates certain properties of a transform", - "description": "All updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", + "summary": "Update a transform", + "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" }, @@ -36036,8 +36052,8 @@ "tags": [ "update_by_query" ], - "summary": "Updates documents that match the specified query", - "description": "If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "summary": "Update documents", + "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ae0fae6465..68bad49f2b 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -688,8 +688,8 @@ "tags": [ "cat.aliases" ], - "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases.\nIMPORTANT: 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.", + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -711,8 +711,8 @@ "tags": [ "cat.aliases" ], - "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases.\nIMPORTANT: 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.", + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -737,8 +737,8 @@ "tags": [ "cat.component_templates" ], - "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -756,8 +756,8 @@ "tags": [ "cat.component_templates" ], - "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -780,8 +780,8 @@ "tags": [ "cat.count" ], - "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -798,8 +798,8 @@ "tags": [ "cat.count" ], - "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -821,7 +821,8 @@ "tags": [ "cat.help" ], - "summary": "Returns help for the Cat APIs", + "summary": "Get CAT help", + "description": "Returns help for the CAT APIs.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html" }, @@ -848,8 +849,8 @@ "tags": [ "cat.indices" ], - "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -886,8 +887,8 @@ "tags": [ "cat.indices" ], - "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -927,8 +928,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -963,8 +964,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1002,8 +1003,8 @@ "tags": [ "cat.ml_datafeeds" ], - "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1035,8 +1036,8 @@ "tags": [ "cat.ml_datafeeds" ], - "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1071,8 +1072,8 @@ "tags": [ "cat.ml_jobs" ], - "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1107,8 +1108,8 @@ "tags": [ "cat.ml_jobs" ], - "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1146,8 +1147,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1185,8 +1186,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1227,8 +1228,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -1266,8 +1267,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -4210,7 +4211,8 @@ "tags": [ "delete_by_query" ], - "summary": "Deletes documents that match the specified query", + "summary": "Delete documents", + "description": "Deletes documents that match the specified query.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html" }, @@ -4798,7 +4800,8 @@ "tags": [ "enrich.get_policy" ], - "summary": "Returns information about an enrich policy", + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, @@ -4819,7 +4822,8 @@ "tags": [ "enrich.put_policy" ], - "summary": "Creates an enrich policy", + "summary": "Create an enrich policy", + "description": "Creates an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html" }, @@ -4876,7 +4880,8 @@ "tags": [ "enrich.delete_policy" ], - "summary": "Deletes an existing enrich policy and its enrich index", + "summary": "Delete an enrich policy", + "description": "Deletes an existing enrich policy and its enrich index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html" }, @@ -4970,7 +4975,8 @@ "tags": [ "enrich.get_policy" ], - "summary": "Returns information about an enrich policy", + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, @@ -4988,7 +4994,8 @@ "tags": [ "enrich.stats" ], - "summary": "Returns enrich coordinator statistics and information about enrich policies that are currently executing", + "summary": "Get enrich stats", + "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html" }, @@ -7852,8 +7859,8 @@ "tags": [ "indices.get_mapping" ], - "summary": "Retrieves mapping definitions for one or more indices", - "description": "For data streams, the API retrieves mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, @@ -7887,8 +7894,8 @@ "tags": [ "indices.get_mapping" ], - "summary": "Retrieves mapping definitions for one or more indices", - "description": "For data streams, the API retrieves mappings for the stream’s backing indices.", + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, @@ -7923,8 +7930,8 @@ "tags": [ "indices.put_mapping" ], - "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -7965,8 +7972,8 @@ "tags": [ "indices.put_mapping" ], - "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -8913,7 +8920,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -8970,7 +8978,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -9029,7 +9038,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -9089,7 +9099,8 @@ "tags": [ "indices.validate_query" ], - "summary": "Validates a potentially expensive query without executing it", + "summary": "Validate a query", + "description": "Validates a query without running it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, @@ -19355,7 +19366,8 @@ "tags": [ "transform.get_transform" ], - "summary": "Retrieves configuration information for transforms", + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" }, @@ -19388,8 +19400,8 @@ "tags": [ "transform.put_transform" ], - "summary": "Creates a transform", - "description": "A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", + "summary": "Create a transform", + "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" }, @@ -19492,7 +19504,8 @@ "tags": [ "transform.delete_transform" ], - "summary": "Deletes a transform", + "summary": "Delete a transform", + "description": "Deletes a transform.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html" }, @@ -19560,7 +19573,8 @@ "tags": [ "transform.get_transform" ], - "summary": "Retrieves configuration information for transforms", + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" }, @@ -19592,7 +19606,8 @@ "tags": [ "transform.get_transform_stats" ], - "summary": "Retrieves usage information for transforms", + "summary": "Get transform stats", + "description": "Retrieves usage information for transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html" }, @@ -19685,8 +19700,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19713,8 +19728,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19743,8 +19758,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19768,8 +19783,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19795,8 +19810,8 @@ "tags": [ "transform.reset_transform" ], - "summary": "Resets a transform", - "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "summary": "Reset a transform", + "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html" }, @@ -19844,8 +19859,8 @@ "tags": [ "transform.schedule_now_transform" ], - "summary": "Schedules now a transform", - "description": "If you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "summary": "Schedule a transform to start now", + "description": "Instantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html" }, @@ -19893,8 +19908,8 @@ "tags": [ "transform.start_transform" ], - "summary": "Starts a transform", - "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "summary": "Start a transform", + "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" }, @@ -19952,7 +19967,8 @@ "tags": [ "transform.stop_transform" ], - "summary": "Stops one or more transforms", + "summary": "Stop transforms", + "description": "Stops one or more transforms.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html" }, @@ -20040,8 +20056,8 @@ "tags": [ "transform.update_transform" ], - "summary": "Updates certain properties of a transform", - "description": "All updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", + "summary": "Update a transform", + "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" }, @@ -20405,8 +20421,8 @@ "tags": [ "update_by_query" ], - "summary": "Updates documents that match the specified query", - "description": "If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "summary": "Update documents", + "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index bd827fb280..88719aada7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -525,7 +525,7 @@ "stability": "stable" } }, - "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\nIMPORTANT: 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.", + "description": "Get aliases.\nRetrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "docId": "cat-alias", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html", "name": "cat.aliases", @@ -620,7 +620,7 @@ "stability": "stable" } }, - "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "description": "Get component templates.\nReturns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html", "name": "cat.component_templates", "privileges": { @@ -666,7 +666,7 @@ "stability": "stable" } }, - "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.\nNOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "description": "Get a document count.\nProvides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "docId": "cat-count", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html", "name": "cat.count", @@ -801,7 +801,7 @@ "stability": "stable" } }, - "description": "Returns help for the Cat APIs.", + "description": "Get CAT help.\nReturns help for the CAT APIs.", "docId": "cat", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html", "name": "cat.help", @@ -836,7 +836,7 @@ "stability": "stable" } }, - "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "Get index information.\nReturns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "docId": "cat-indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-indices.html", "name": "cat.indices", @@ -928,7 +928,7 @@ "stability": "stable" } }, - "description": "Returns configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "description": "Get data frame analytics jobs.\nReturns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "docId": "cat-dfanalytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html", "name": "cat.ml_data_frame_analytics", @@ -976,7 +976,7 @@ "stability": "stable" } }, - "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "description": "Get datafeeds.\nReturns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "docId": "cat-datafeeds", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html", "name": "cat.ml_datafeeds", @@ -1024,7 +1024,7 @@ "stability": "stable" } }, - "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "description": "Get anomaly detection jobs.\nReturns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "docId": "cat-anomaly-detectors", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html", "name": "cat.ml_jobs", @@ -1072,7 +1072,7 @@ "stability": "stable" } }, - "description": "Returns configuration and usage information about inference trained models.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "description": "Get trained models.\nReturns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "docId": "cat-trained-model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html", "name": "cat.ml_trained_models", @@ -1661,7 +1661,7 @@ "stability": "stable" } }, - "description": "Returns configuration and usage information about transforms.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transforms.\nReturns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "docId": "cat-transforms", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html", "name": "cat.transforms", @@ -4283,7 +4283,7 @@ "stability": "stable" } }, - "description": "Deletes documents that match the specified query.", + "description": "Delete documents.\nDeletes documents that match the specified query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "name": "delete_by_query", "request": { @@ -4390,7 +4390,7 @@ "stability": "stable" } }, - "description": "Deletes an existing enrich policy and its enrich index.", + "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "name": "enrich.delete_policy", "request": { @@ -4461,7 +4461,7 @@ "stability": "stable" } }, - "description": "Returns information about an enrich policy.", + "description": "Get an enrich policy.\nReturns information about an enrich policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "name": "enrich.get_policy", "request": { @@ -4502,7 +4502,7 @@ "stability": "stable" } }, - "description": "Creates an enrich policy.", + "description": "Create an enrich policy.\nCreates an enrich policy.", "docId": "put-enrich-policy-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", "name": "enrich.put_policy", @@ -4541,7 +4541,7 @@ "stability": "stable" } }, - "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", + "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "name": "enrich.stats", "request": { @@ -6998,7 +6998,7 @@ "stability": "stable" } }, - "description": "Retrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "name": "indices.get_field_mapping", "request": { @@ -7085,7 +7085,7 @@ "stability": "stable" } }, - "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "name": "indices.get_mapping", "request": { @@ -7482,7 +7482,7 @@ "stability": "stable" } }, - "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "description": "Update field mappings.\nAdds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "name": "indices.put_mapping", "request": { @@ -8199,7 +8199,7 @@ "stability": "stable" } }, - "description": "Validates a potentially expensive query without executing it.", + "description": "Validate a query.\nValidates a query without running it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", "name": "indices.validate_query", "request": { @@ -18920,7 +18920,7 @@ "stability": "stable" } }, - "description": "Deletes a transform.", + "description": "Delete a transform.\nDeletes a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "name": "transform.delete_transform", "privileges": { @@ -18985,7 +18985,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for transforms.", + "description": "Get transforms.\nRetrieves configuration information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "name": "transform.get_transform", "privileges": { @@ -19031,7 +19031,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for transforms.", + "description": "Get transform stats.\nRetrieves usage information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "name": "transform.get_transform_stats", "privileges": { @@ -19075,7 +19075,7 @@ "stability": "stable" } }, - "description": "Previews a transform.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "name": "transform.preview_transform", "privileges": { @@ -19130,7 +19130,7 @@ "stability": "stable" } }, - "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", + "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "name": "transform.put_transform", "privileges": { @@ -19179,7 +19179,7 @@ "stability": "stable" } }, - "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", "name": "transform.reset_transform", "privileges": { @@ -19219,7 +19219,7 @@ "stability": "stable" } }, - "description": "Schedules now a transform.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", "name": "transform.schedule_now_transform", "privileges": { @@ -19262,7 +19262,7 @@ "stability": "stable" } }, - "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "name": "transform.start_transform", "privileges": { @@ -19306,7 +19306,7 @@ "stability": "stable" } }, - "description": "Stops one or more transforms.", + "description": "Stop transforms.\nStops one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "name": "transform.stop_transform", "privileges": { @@ -19346,7 +19346,7 @@ "stability": "stable" } }, - "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", + "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "name": "transform.update_transform", "privileges": { @@ -19474,7 +19474,7 @@ "stability": "stable" } }, - "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", "request": { @@ -21815,7 +21815,7 @@ } ] }, - "description": "Deletes documents that match the specified query.", + "description": "Delete documents.\nDeletes documents that match the specified query.", "inherits": { "type": { "name": "RequestBase", @@ -22210,7 +22210,7 @@ } } ], - "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L209" + "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L210" }, { "body": { @@ -40044,7 +40044,7 @@ } ] }, - "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "inherits": { "type": { "name": "RequestBase", @@ -40451,7 +40451,7 @@ } } ], - "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L221" + "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L222" }, { "body": { @@ -85734,7 +85734,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\nIMPORTANT: 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.", + "description": "Get aliases.\nRetrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n> info\n> 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).", "inherits": { "type": { "name": "CatRequestBase", @@ -85774,7 +85774,7 @@ } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L41" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L43" }, { "body": { @@ -86303,7 +86303,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "description": "Get component templates.\nReturns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_component_template endpoints](#endpoint-component-template).", "inherits": { "type": { "name": "CatRequestBase", @@ -86330,7 +86330,7 @@ } ], "query": [], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L37" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L39" }, { "body": { @@ -86439,7 +86439,7 @@ "body": { "kind": "no_body" }, - "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.\nNOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "description": "Get a document count.\nProvides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use [the /_count endpoints](#endpoint-count).", "inherits": { "type": { "name": "CatRequestBase", @@ -86466,7 +86466,7 @@ } ], "query": [], - "specLocation": "cat/count/CatCountRequest.ts#L23-L42" + "specLocation": "cat/count/CatCountRequest.ts#L23-L44" }, { "body": { @@ -87019,7 +87019,7 @@ "body": { "kind": "no_body" }, - "description": "Returns help for the Cat APIs.", + "description": "Get CAT help.\nReturns help for the CAT APIs.", "inherits": { "type": { "name": "CatRequestBase", @@ -87033,7 +87033,7 @@ }, "path": [], "query": [], - "specLocation": "cat/help/CatHelpRequest.ts#L22-L28" + "specLocation": "cat/help/CatHelpRequest.ts#L22-L30" }, { "body": { @@ -89112,7 +89112,7 @@ "body": { "kind": "no_body" }, - "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "Get index information.\nReturns high-level information about indices in a cluster, including backing indices for data streams.\n> info\n> CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese 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.\nTo get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints.", "inherits": { "type": { "name": "CatRequestBase", @@ -89214,7 +89214,7 @@ } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L68" + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L77" }, { "body": { @@ -89611,7 +89611,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "description": "Get data frame analytics jobs.\nReturns configuration and usage information about data frame analytics jobs.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml).", "inherits": { "type": { "name": "CatRequestBase", @@ -89700,7 +89700,7 @@ } } ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L58" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L60" }, { "body": { @@ -89927,7 +89927,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "description": "Get datafeeds.\nReturns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml).", "inherits": { "type": { "name": "CatRequestBase", @@ -90005,7 +90005,7 @@ } } ], - "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L73" + "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L75" }, { "body": { @@ -90998,7 +90998,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "description": "Get anomaly detection jobs.\nReturns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml).", "inherits": { "type": { "name": "CatRequestBase", @@ -91088,7 +91088,7 @@ } } ], - "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L77" + "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L79" }, { "body": { @@ -91119,7 +91119,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information about inference trained models.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "description": "Get trained models.\nReturns configuration and usage information about inference trained models.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_ml/trained_models endpoints](#endpoint-ml).", "inherits": { "type": { "name": "CatRequestBase", @@ -91220,7 +91220,7 @@ } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L63" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L65" }, { "body": { @@ -97049,7 +97049,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information about transforms.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transforms.\nReturns configuration and usage information about transforms.\n\n> info\n> CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use [the /_transform endpoints](#endpoint-transform).", "inherits": { "type": { "name": "CatRequestBase", @@ -97153,7 +97153,7 @@ } } ], - "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L77" + "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L79" }, { "body": { @@ -111232,7 +111232,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing enrich policy and its enrich index.", + "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", "inherits": { "type": { "name": "RequestBase", @@ -111259,7 +111259,7 @@ } ], "query": [], - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L36" + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L37" }, { "body": { @@ -111414,7 +111414,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about an enrich policy.", + "description": "Get an enrich policy.\nReturns information about an enrich policy.", "inherits": { "type": { "name": "RequestBase", @@ -111441,7 +111441,7 @@ } ], "query": [], - "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L37" + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L38" }, { "body": { @@ -111515,7 +111515,7 @@ } ] }, - "description": "Creates an enrich policy.", + "description": "Create an enrich policy.\nCreates an enrich policy.", "inherits": { "type": { "name": "RequestBase", @@ -111542,7 +111542,7 @@ } ], "query": [], - "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L52" + "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L53" }, { "body": { @@ -111731,7 +111731,7 @@ "body": { "kind": "no_body" }, - "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", + "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", "inherits": { "type": { "name": "RequestBase", @@ -111745,7 +111745,7 @@ }, "path": [], "query": [], - "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L28" + "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L29" }, { "body": { @@ -126130,7 +126130,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -126235,7 +126235,7 @@ } } ], - "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingRequest.ts#L23-L73" + "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingRequest.ts#L23-L74" }, { "body": { @@ -126494,7 +126494,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -126587,7 +126587,7 @@ } } ], - "specLocation": "indices/get_mapping/IndicesGetMappingRequest.ts#L24-L72" + "specLocation": "indices/get_mapping/IndicesGetMappingRequest.ts#L24-L73" }, { "body": { @@ -128047,7 +128047,7 @@ } ] }, - "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "description": "Update field mappings.\nAdds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "inherits": { "type": { "name": "RequestBase", @@ -128153,7 +128153,7 @@ } } ], - "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L42-L149" + "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L42-L150" }, { "body": { @@ -134508,7 +134508,7 @@ } ] }, - "description": "Validates a potentially expensive query without executing it.", + "description": "Validate a query.\nValidates a query without running it.", "inherits": { "type": { "name": "RequestBase", @@ -134689,7 +134689,7 @@ } } ], - "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L111" + "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L112" }, { "body": { @@ -198662,7 +198662,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a transform.", + "description": "Delete a transform.\nDeletes a transform.", "inherits": { "type": { "name": "RequestBase", @@ -198729,7 +198729,7 @@ } } ], - "specLocation": "transform/delete_transform/DeleteTransformRequest.ts#L24-L57" + "specLocation": "transform/delete_transform/DeleteTransformRequest.ts#L24-L58" }, { "body": { @@ -198756,7 +198756,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves configuration information for transforms.", + "description": "Get transforms.\nRetrieves configuration information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -198836,7 +198836,7 @@ } } ], - "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L72" + "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L73" }, { "body": { @@ -199235,7 +199235,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for transforms.", + "description": "Get transform stats.\nRetrieves usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -199314,7 +199314,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L68" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L69" }, { "body": { @@ -199890,7 +199890,7 @@ } ] }, - "description": "Previews a transform.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "inherits": { "type": { "name": "RequestBase", @@ -199931,7 +199931,7 @@ } } ], - "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L107" + "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L108" }, { "body": { @@ -200107,7 +200107,7 @@ } ] }, - "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", + "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "inherits": { "type": { "name": "RequestBase", @@ -200161,7 +200161,7 @@ } } ], - "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L122" + "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L123" }, { "body": { @@ -200188,7 +200188,7 @@ "body": { "kind": "no_body" }, - "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "inherits": { "type": { "name": "RequestBase", @@ -200229,7 +200229,7 @@ } } ], - "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L23-L48" + "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L23-L49" }, { "body": { @@ -200256,7 +200256,7 @@ "body": { "kind": "no_body" }, - "description": "Schedules now a transform.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "inherits": { "type": { "name": "RequestBase", @@ -200297,7 +200297,7 @@ } } ], - "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L49" + "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L50" }, { "body": { @@ -200324,7 +200324,7 @@ "body": { "kind": "no_body" }, - "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "inherits": { "type": { "name": "RequestBase", @@ -200377,7 +200377,7 @@ } } ], - "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L65" + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L66" }, { "body": { @@ -200404,7 +200404,7 @@ "body": { "kind": "no_body" }, - "description": "Stops one or more transforms.", + "description": "Stop transforms.\nStops one or more transforms.", "inherits": { "type": { "name": "RequestBase", @@ -200497,7 +200497,7 @@ } } ], - "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L76" + "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L77" }, { "body": { @@ -200635,7 +200635,7 @@ } ] }, - "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", + "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "inherits": { "type": { "name": "RequestBase", @@ -200688,7 +200688,7 @@ } } ], - "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L105" + "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L106" }, { "body": { diff --git a/specification/_global/delete_by_query/DeleteByQueryRequest.ts b/specification/_global/delete_by_query/DeleteByQueryRequest.ts index 69f1acb978..415b9baab8 100644 --- a/specification/_global/delete_by_query/DeleteByQueryRequest.ts +++ b/specification/_global/delete_by_query/DeleteByQueryRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' import { Operator } from '@_types/query_dsl/Operator' /** + * Delete documents. * Deletes documents that match the specified query. * @rest_spec_name delete_by_query * @availability stack since=5.0.0 stability=stable diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index 4faa5db109..c23ea364cd 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -35,6 +35,7 @@ import { Duration } from '@_types/Time' import { Operator } from '@_types/query_dsl/Operator' /** + * Update documents. * Updates documents that match the specified query. * If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. * @rest_spec_name update_by_query diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index 16b7e744d4..badc120ad7 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -21,9 +21,11 @@ import { CatRequestBase } from '@cat/_types/CatBase' 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. - * IMPORTANT: 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. + * > 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). * @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 8f361b4329..aaea7272ed 100644 --- a/specification/cat/component_templates/CatComponentTemplatesRequest.ts +++ b/specification/cat/component_templates/CatComponentTemplatesRequest.ts @@ -20,10 +20,12 @@ 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. - * IMPORTANT: 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 get component template API. + * > 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). * @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 4de33ef923..409fe4a757 100644 --- a/specification/cat/count/CatCountRequest.ts +++ b/specification/cat/count/CatCountRequest.ts @@ -21,10 +21,12 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Indices } from '@_types/common' /** - * Provides quick access to a document count for a data stream, an index, or an entire cluster. - * NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. - * IMPORTANT: 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 API. + * 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). * @rest_spec_name cat.count * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/cat/help/CatHelpRequest.ts b/specification/cat/help/CatHelpRequest.ts index 5d57071f6e..3493c6ca2d 100644 --- a/specification/cat/help/CatHelpRequest.ts +++ b/specification/cat/help/CatHelpRequest.ts @@ -20,6 +20,8 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** + * Get CAT help. + * Returns help for the CAT APIs. * @rest_spec_name cat.help * @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 9099598778..439642254f 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -22,12 +22,21 @@ import { Bytes, ExpandWildcards, HealthStatus, Indices } from '@_types/common' import { TimeUnit } from '@_types/Time' /** + * Get index information. * Returns high-level information about indices in a cluster, including backing indices for data streams. - * IMPORTANT: 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 get index API. - * Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. + * > 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 + * - document count + * - deleted document count + * - primary store size + * - 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 APIs. + * To get an accurate count of Elasticsearch documents, use the [/_cat/count](#operation-cat-count) or [count](#endpoint-count) endpoints. * @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 index f3dfdac108..ac19b8455b 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -22,11 +22,13 @@ import { Bytes, Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get data frame analytics jobs. * Returns configuration and usage information about data frame analytics jobs. * - * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * > info + * > 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 get data frame analytics jobs statistics API. + * application consumption, use [the /_ml/data_frame/analytics endpoints](#endpoint-ml). * * @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 9396b2cabb..e99f0d69d4 100644 --- a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts +++ b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts @@ -22,14 +22,16 @@ import { Id } from '@_types/common' import { TimeUnit } from '@_types/Time' /** + * Get datafeeds. * Returns configuration and usage information about datafeeds. * This API returns a maximum of 10,000 datafeeds. * If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` * cluster privileges to use this API. * - * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * > info + * > 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 get datafeed statistics API. + * application consumption, use [the /_ml/datafeeds endpoints](#endpoint-ml). * * @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 b477cf51ec..df46bad431 100644 --- a/specification/cat/ml_jobs/CatJobsRequest.ts +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -22,14 +22,16 @@ import { Bytes, Id } from '@_types/common' import { TimeUnit } from '@_types/Time' /** + * Get anomaly detection jobs. * Returns configuration and usage information for anomaly detection jobs. * This API returns a maximum of 10,000 jobs. * If the Elasticsearch security features are enabled, you must have `monitor_ml`, * `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. * - * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * > info + * > 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 get anomaly detection job statistics API. + * application consumption, use [the /_ml/anomaly_detectors endpoints](#endpoint-ml). * * @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 1f7d3eff48..1776b48944 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -22,11 +22,13 @@ import { Bytes, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Get trained models. * Returns configuration and usage information about inference trained models. * - * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * > info + * > 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 get trained models statistics API. + * application consumption, use [the /_ml/trained_models endpoints](#endpoint-ml). * * @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 5b5f4c9bc7..62191c7b36 100644 --- a/specification/cat/transforms/CatTransformsRequest.ts +++ b/specification/cat/transforms/CatTransformsRequest.ts @@ -23,11 +23,13 @@ import { integer } from '@_types/Numeric' import { Duration, TimeUnit } from '@_types/Time' /** + * Get transforms. * Returns configuration and usage information about transforms. * - * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * > info + * > 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 get transform statistics API. + * application consumption, use [the /_transform endpoints](#endpoint-transform). * * @rest_spec_name cat.transforms * @availability stack since=7.7.0 stability=stable diff --git a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts index 8b837981b3..1f46679bf0 100644 --- a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts +++ b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Delete an enrich policy. * Deletes an existing enrich policy and its enrich index. * @rest_spec_name enrich.delete_policy * @availability stack since=7.5.0 stability=stable diff --git a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts index b6a1a5d301..bee0b8bbf8 100644 --- a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts +++ b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Get an enrich policy. * Returns information about an enrich policy. * @rest_spec_name enrich.get_policy * @availability stack since=7.5.0 stability=stable diff --git a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts index 6c2aacae88..0aee24f900 100644 --- a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts +++ b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts @@ -22,6 +22,7 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Create an enrich policy. * Creates an enrich policy. * @doc_id put-enrich-policy-api * @rest_spec_name enrich.put_policy diff --git a/specification/enrich/stats/EnrichStatsRequest.ts b/specification/enrich/stats/EnrichStatsRequest.ts index 6d63db512e..803dadb3d6 100644 --- a/specification/enrich/stats/EnrichStatsRequest.ts +++ b/specification/enrich/stats/EnrichStatsRequest.ts @@ -20,6 +20,7 @@ import { RequestBase } from '@_types/Base' /** + * Get enrich stats. * Returns enrich coordinator statistics and information about enrich policies that are currently executing. * @rest_spec_name enrich.stats * @availability stack since=7.5.0 stability=stable diff --git a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts index 66157257cb..cb238daf74 100644 --- a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts +++ b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Fields, Indices } from '@_types/common' /** + * Get mapping definitions. * Retrieves mapping definitions for one or more fields. * For data streams, the API retrieves field mappings for the stream’s backing indices. * @rest_spec_name indices.get_field_mapping diff --git a/specification/indices/get_mapping/IndicesGetMappingRequest.ts b/specification/indices/get_mapping/IndicesGetMappingRequest.ts index 8f40a3d3e5..0c93162289 100644 --- a/specification/indices/get_mapping/IndicesGetMappingRequest.ts +++ b/specification/indices/get_mapping/IndicesGetMappingRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get mapping definitions. * Retrieves mapping definitions for one or more indices. * For data streams, the API retrieves mappings for the stream’s backing indices. * @rest_spec_name indices.get_mapping diff --git a/specification/indices/put_mapping/IndicesPutMappingRequest.ts b/specification/indices/put_mapping/IndicesPutMappingRequest.ts index 720a47c36d..b99a32ed32 100644 --- a/specification/indices/put_mapping/IndicesPutMappingRequest.ts +++ b/specification/indices/put_mapping/IndicesPutMappingRequest.ts @@ -40,6 +40,7 @@ import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { Duration } from '@_types/Time' /** + * Update field mappings. * Adds new fields to an existing data stream or index. * You can also use this API to change the search settings of existing fields. * For data streams, these changes are applied to all backing indices by default. diff --git a/specification/indices/validate_query/IndicesValidateQueryRequest.ts b/specification/indices/validate_query/IndicesValidateQueryRequest.ts index d41002c5ef..472541740e 100644 --- a/specification/indices/validate_query/IndicesValidateQueryRequest.ts +++ b/specification/indices/validate_query/IndicesValidateQueryRequest.ts @@ -23,7 +23,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Operator } from '@_types/query_dsl/Operator' /** - * Validates a potentially expensive query without executing it. + * Validate a query. + * Validates a query without running it. * @rest_spec_name indices.validate_query * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/transform/delete_transform/DeleteTransformRequest.ts b/specification/transform/delete_transform/DeleteTransformRequest.ts index 898474b29a..c04fb4ac08 100644 --- a/specification/transform/delete_transform/DeleteTransformRequest.ts +++ b/specification/transform/delete_transform/DeleteTransformRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete a transform. * Deletes a transform. * @rest_spec_name transform.delete_transform * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/get_transform/GetTransformRequest.ts b/specification/transform/get_transform/GetTransformRequest.ts index eee306b342..4b520519d0 100644 --- a/specification/transform/get_transform/GetTransformRequest.ts +++ b/specification/transform/get_transform/GetTransformRequest.ts @@ -22,6 +22,7 @@ import { Name, Names } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Get transforms. * Retrieves configuration information for transforms. * @rest_spec_name transform.get_transform * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts index f78a469701..2428a43e94 100644 --- a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts +++ b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts @@ -23,6 +23,7 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Get transform stats. * Retrieves usage information for transforms. * @rest_spec_name transform.get_transform_stats * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/preview_transform/PreviewTransformRequest.ts b/specification/transform/preview_transform/PreviewTransformRequest.ts index 29b00820b3..6ff10ec678 100644 --- a/specification/transform/preview_transform/PreviewTransformRequest.ts +++ b/specification/transform/preview_transform/PreviewTransformRequest.ts @@ -31,7 +31,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Previews a transform. + * Preview a transform. + * Generates a preview of the results that you will get when you create a transform with the same configuration. * * It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also * generates a list of mappings and settings for the destination index. These values are determined based on the field diff --git a/specification/transform/put_transform/PutTransformRequest.ts b/specification/transform/put_transform/PutTransformRequest.ts index 664d9f96dc..ad447d63f2 100644 --- a/specification/transform/put_transform/PutTransformRequest.ts +++ b/specification/transform/put_transform/PutTransformRequest.ts @@ -31,6 +31,7 @@ import { Id, Metadata } from '@_types/common' import { Duration } from '@_types/Time' /** + * Create a transform. * Creates a transform. * * A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as diff --git a/specification/transform/reset_transform/ResetTransformRequest.ts b/specification/transform/reset_transform/ResetTransformRequest.ts index 611145aea9..5dc089b75b 100644 --- a/specification/transform/reset_transform/ResetTransformRequest.ts +++ b/specification/transform/reset_transform/ResetTransformRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Reset a transform. * Resets a transform. * Before you can reset it, you must stop it; alternatively, use the `force` query parameter. * If the destination index was created by the transform, it is deleted. diff --git a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts index 8e1a9c93b9..e0b91fb99e 100644 --- a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts +++ b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts @@ -21,7 +21,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Schedules now a transform. + * Schedule a transform to start now. + * Instantly runs a transform to process data. * * If you _schedule_now a transform, it will process the new data instantly, * without waiting for the configured frequency interval. After _schedule_now API is called, diff --git a/specification/transform/start_transform/StartTransformRequest.ts b/specification/transform/start_transform/StartTransformRequest.ts index 702ba5439d..66052b6750 100644 --- a/specification/transform/start_transform/StartTransformRequest.ts +++ b/specification/transform/start_transform/StartTransformRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Start a transform. * Starts a transform. * * When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is diff --git a/specification/transform/stop_transform/StopTransformRequest.ts b/specification/transform/stop_transform/StopTransformRequest.ts index 1048c7f1c4..3f21c2f3df 100644 --- a/specification/transform/stop_transform/StopTransformRequest.ts +++ b/specification/transform/stop_transform/StopTransformRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Stop transforms. * Stops one or more transforms. * @rest_spec_name transform.stop_transform * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/update_transform/UpdateTransformRequest.ts b/specification/transform/update_transform/UpdateTransformRequest.ts index 1b92ef59cf..36af770aed 100644 --- a/specification/transform/update_transform/UpdateTransformRequest.ts +++ b/specification/transform/update_transform/UpdateTransformRequest.ts @@ -29,6 +29,7 @@ import { Id, Metadata } from '@_types/common' import { Duration } from '@_types/Time' /** + * Update a transform. * Updates certain properties of a transform. * * All updated properties except `description` do not take effect until after the transform starts the next checkpoint,