Auto-generated API code

Author: elasticmachine

docs/reference.asciidoc

@@ -1955,7 +1955,7 @@ client.indices.create({ index })
 - Field names
 - Field data types
 - Mapping parameters
-** *`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, shards, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })*: Configuration options for the index.
+** *`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })*: Configuration options for the index.
 ** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
 If no response is received before the timeout expires, the request fails and returns an error.
 ** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response.
@@ -2097,7 +2097,7 @@ client.indices.deleteDataStream({ name })
 ==== delete_index_template
 Deletes an index template.
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-delete-template.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.deleteIndexTemplate({ name })
@@ -2167,7 +2167,7 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
 ==== exists_index_template
 Returns information about whether a particular index template exists.
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/index-templates.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.existsIndexTemplate({ name })
@@ -2300,7 +2300,7 @@ Supports a list of values, such as `open,hidden`.
 ==== get_index_template
 Returns an index template.
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-get-template.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.getIndexTemplate({ ... })
@@ -2483,7 +2483,7 @@ If no response is received before the timeout expires, the request fails and ret
 ==== put_index_template
 Creates or updates an index template.
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-put-template.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.putIndexTemplate({ name })
@@ -2539,7 +2539,7 @@ a new date field is added instead of string.
 not used at all by Elasticsearch, but can be used to store
 application-specific metadata.
 ** *`numeric_detection` (Optional, boolean)*: Automatically map strings into numeric data types for all fields.
-** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, dims, similarity, index, index_options } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type }>)*: Mapping for a field. For new fields, this mapping can include:
+** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, dims, similarity, index, index_options } | { type } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type }>)*: Mapping for a field. For new fields, this mapping can include:
 
 - Field name
 - Field data type
@@ -2577,7 +2577,7 @@ client.indices.putSettings({ ... })
 ** *`index` (Optional, string | string[])*: List of data streams, indices, and aliases used to limit
 the request. Supports wildcards (`*`). To target all data streams and
 indices, omit this parameter or use `*` or `_all`.
-** *`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, shards, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })*
+** *`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })*
 ** *`allow_no_indices` (Optional, boolean)*: If `false`, the request returns an error if any wildcard expression, index
 alias, or `_all` value targets only missing or closed indices. This
 behavior applies even if the request targets other open indices. For
@@ -2600,7 +2600,7 @@ error.
 ==== put_template
 Creates or updates an index template.
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-templates-v1.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.putTemplate({ name })
@@ -2718,7 +2718,7 @@ Set to all or any positive integer up to the total number of shards in the index
 ==== simulate_index_template
 Simulate matching the given index name against the index templates in the system
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-simulate-index.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.simulateIndexTemplate({ name })
@@ -2761,7 +2761,7 @@ before the timeout expires, the request fails and returns an error.
 ==== simulate_template
 Simulate resolving the given template name or body
 
-{ref}/indices-templates.html[Endpoint documentation]
+{ref}/indices-simulate-template.html[Endpoint documentation]
 [source,ts]
 ----
 client.indices.simulateTemplate({ ... })
@@ -2930,7 +2930,7 @@ client.ingest.simulate({ ... })
 ** *`id` (Optional, string)*: Pipeline to test.
 If you don’t specify a `pipeline` in the request body, this parameter is required.
 ** *`docs` (Optional, { _id, _index, _source }[])*: Sample documents to test in the pipeline.
-** *`pipeline` (Optional, { description, on_failure, processors, version })*: Pipeline to test.
+** *`pipeline` (Optional, { description, on_failure, processors, version, _meta })*: Pipeline to test.
 If you don’t specify the `pipeline` request path parameter, this parameter is required.
 If you specify both this and the request path parameter, the API only uses the request path parameter.
 ** *`verbose` (Optional, boolean)*: If `true`, the response includes output data for each processor in the executed pipeline.
@@ -2980,14 +2980,14 @@ Retrieves Logstash Pipelines used by Central Management
 {ref}/logstash-api-get-pipeline.html[Endpoint documentation]
 [source,ts]
 ----
-client.logstash.getPipeline({ id })
+client.logstash.getPipeline({ ... })
 ----
 
 [discrete]
 ==== Arguments
 
 * *Request (object):*
-** *`id` (string | string[])*: List of pipeline identifiers.
+** *`id` (Optional, string | string[])*: List of pipeline identifiers.
 
 [discrete]
 ==== put_pipeline
@@ -3004,7 +3004,7 @@ client.logstash.putPipeline({ id })
 
 * *Request (object):*
 ** *`id` (string)*: Identifier for the pipeline.
-** *`pipeline` (Optional, { description, on_failure, processors, version })*
+** *`pipeline` (Optional, { description, on_failure, processors, version, _meta })*
 
 [discrete]
 === ml
@@ -4434,7 +4434,7 @@ client.queryRuleset.put({ ruleset_id, rules })
 ==== delete
 Deletes a search application.
 
-{ref}/put-search-application.html[Endpoint documentation]
+{ref}/delete-search-application.html[Endpoint documentation]
 [source,ts]
 ----
 client.searchApplication.delete({ name })
@@ -4710,6 +4710,7 @@ client.security.updateApiKey({ id })
 ** *`id` (string)*: The ID of the API key to update.
 ** *`role_descriptors` (Optional, Record<string, { cluster, indices, global, applications, metadata, run_as, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
 ** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.
+** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key.
 
 [discrete]
 === sql
@@ -5000,6 +5001,8 @@ client.transform.deleteTransform({ transform_id })
 ** *`transform_id` (string)*: Identifier for the transform.
 ** *`force` (Optional, boolean)*: If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
 deleted regardless of its current state.
+** *`delete_dest_index` (Optional, boolean)*: If this value is true, the destination index is deleted together with the transform. If false, the destination
+index will not be deleted
 ** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
 
 [discrete]

src/api/api/eql.ts

@@ -71,7 +71,7 @@ export default class Eql {
 
   /**
     * Returns async results from previously executed Event Query Language (EQL) search
-    * @see {@link  https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
     */
   async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetResponse<TEvent>>
   async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetResponse<TEvent>, unknown>>
@@ -97,7 +97,7 @@ export default class Eql {
 
   /**
     * Returns the status of a previously submitted async or stored Event Query Language (EQL) search
-    * @see {@link  https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
+    * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
     */
   async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetStatusResponse>
   async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetStatusResponse, unknown>>