From 029abc62fe672d8cebe252f2acde9405def3944f Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 2 Dec 2024 06:03:34 +0000 Subject: [PATCH] Auto-generated API code --- docs/reference.asciidoc | 88 +++++++++----- src/api/api/async_search.ts | 2 +- src/api/api/clear_scroll.ts | 2 +- src/api/api/close_point_in_time.ts | 2 +- src/api/api/field_caps.ts | 2 +- src/api/api/msearch_template.ts | 2 +- src/api/api/open_point_in_time.ts | 2 +- src/api/api/rank_eval.ts | 2 +- src/api/api/render_search_template.ts | 2 +- src/api/api/search.ts | 2 +- src/api/api/search_mvt.ts | 2 +- src/api/api/search_template.ts | 2 +- src/api/api/termvectors.ts | 2 +- src/api/types.ts | 157 +++++++++++++++++++++---- src/api/typesWithBodyKey.ts | 163 ++++++++++++++++++++++---- 15 files changed, 345 insertions(+), 87 deletions(-) diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 3cd7b3f..0b824f5 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -58,7 +58,9 @@ Set to all or any positive integer up to the total number of shards in the index [discrete] === clear_scroll -Clears the search context and results for a scrolling search. +Clear a scrolling search. + +Clear the search context and results for a scrolling search. {ref}/clear-scroll-api.html[Endpoint documentation] [source,ts] @@ -74,7 +76,12 @@ To clear all scroll IDs, use `_all`. [discrete] === close_point_in_time -Closes a point-in-time. +Close a point in time. + +A point in time must be opened explicitly before being used in search requests. +The `keep_alive` parameter tells Elasticsearch how long it should persist. +A point in time is automatically closed when the `keep_alive` period has elapsed. +However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. {ref}/point-in-time-api.html[Endpoint documentation] [source,ts] @@ -370,9 +377,13 @@ Random by default. [discrete] === field_caps -The field capabilities API returns the information about the capabilities of fields among multiple indices. -The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -of keyword is returned as any other field that belongs to the `keyword` family. +Get the field capabilities. + +Get information about the capabilities of fields among multiple indices. + +For data streams, the API returns field capabilities among the stream’s backing indices. +It returns runtime fields like any other field. +For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. {ref}/search-field-caps.html[Endpoint documentation] [source,ts] @@ -606,7 +617,7 @@ However, using computationally expensive named queries on a large number of hits [discrete] === msearch_template -Runs multiple templated searches with a single request. +Run multiple templated searches. {ref}/search-multi-search.html[Endpoint documentation] [source,ts] @@ -666,13 +677,18 @@ Random by default. [discrete] === open_point_in_time -A search request by default executes against the most recent visible data of the target indices, +Open a point in time. + +A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. +A point in time must be opened explicitly before being used in search requests. +The `keep_alive` parameter tells Elasticsearch how long it should persist. + {ref}/point-in-time-api.html[Endpoint documentation] [source,ts] ---- @@ -692,6 +708,8 @@ Random by default. ** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. +** *`allow_partial_search_results` (Optional, boolean)*: If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. +If `true`, the point in time will contain all the shards that are available at the time of the request. [discrete] === ping @@ -730,7 +748,9 @@ If no response is received before the timeout expires, the request fails and ret [discrete] === rank_eval -Enables you to evaluate the quality of ranked search results over a set of typical search queries. +Evaluate ranked search results. + +Evaluate the quality of ranked search results over a set of typical search queries. {ref}/search-rank-eval.html[Endpoint documentation] [source,ts] @@ -784,7 +804,9 @@ Set to `all` or any positive integer up to the total number of shards in the ind [discrete] === render_search_template -Renders a search template as a search request body. +Render a search template. + +Render a search template as a search request body. {ref}/render-search-template-api.html[Endpoint documentation] [source,ts] @@ -856,7 +878,9 @@ client.scroll({ scroll_id }) [discrete] === search -Returns search hits that match the query defined in the request. +Run a search. + +Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. @@ -897,7 +921,7 @@ A post filter has no impact on the aggregation results. NOTE: This is a debugging tool and adds significant overhead to search execution. ** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Defines the search definition using the Query DSL. ** *`rescore` (Optional, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[])*: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. -** *`retriever` (Optional, { standard, knn, rrf, text_similarity_reranker })*: A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. +** *`retriever` (Optional, { standard, knn, rrf, text_similarity_reranker, rule })*: A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. ** *`script_fields` (Optional, Record)*: Retrieve a script evaluation (based on different fields) for each hit. ** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Used to retrieve the next page of hits using a set of sort values from the previous page. ** *`size` (Optional, number)*: The number of hits to return. @@ -965,8 +989,6 @@ However, using computationally expensive named queries on a large number of hits This parameter can only be used when the `q` query string parameter is specified. ** *`max_concurrent_shard_requests` (Optional, number)*: Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. -** *`min_compatible_shard_node` (Optional, string)*: The minimum version of the node that can handle the request -Any handling node with a lower version will fail the request. ** *`preference` (Optional, string)*: Nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: `_only_local` to run the search only on shards on the local node; @@ -1010,7 +1032,8 @@ Query parameter searches do not support the full Elasticsearch Query DSL but are [discrete] === search_mvt Search a vector tile. -Searches a vector tile for geospatial values. + +Search a vector tile for geospatial values. {ref}/search-vector-tile-api.html[Endpoint documentation] [source,ts] @@ -1069,7 +1092,7 @@ suggested label positions for the original features. [discrete] === search_template -Runs a search with a search template. +Run a search with a search template. {ref}/search-template.html[Endpoint documentation] [source,ts] @@ -1144,7 +1167,8 @@ client.termsEnum({ index, field }) [discrete] === termvectors Get term vector information. -Returns information and statistics about terms in the fields of a particular document. + +Get information and statistics about terms in the fields of a particular document. {ref}/docs-termvectors.html[Endpoint documentation] [source,ts] @@ -1291,6 +1315,7 @@ Set to `all` or any positive integer up to the total number of shards in the ind [discrete] ==== delete Delete an async search. + If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. @@ -1310,6 +1335,7 @@ client.asyncSearch.delete({ id }) [discrete] ==== get Get async search results. + Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. @@ -1336,8 +1362,9 @@ By default no timeout is set meaning that the currently available results will b [discrete] ==== status -Get async search status. -Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. +Get the async search status. + +Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. {ref}/async-search.html[Endpoint documentation] @@ -1351,10 +1378,13 @@ client.asyncSearch.status({ id }) * *Request (object):* ** *`id` (string)*: A unique identifier for the async search. +** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available. +Ongoing async searches and any saved search results are deleted after this period. [discrete] ==== submit Run an async search. + When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. @@ -1447,19 +1477,17 @@ A partial reduction is performed every time the coordinating node has received a ** *`ignore_unavailable` (Optional, boolean)*: Whether specified concrete indices should be ignored when unavailable (missing or closed) ** *`lenient` (Optional, boolean)*: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored ** *`max_concurrent_shard_requests` (Optional, number)*: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests -** *`min_compatible_shard_node` (Optional, string)* ** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on (default: random) ** *`pre_filter_shard_size` (Optional, number)*: The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. ** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true ** *`routing` (Optional, string)*: A list of specific routing values -** *`scroll` (Optional, string | -1 | 0)* ** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type ** *`suggest_field` (Optional, string)*: Specifies which field to use for suggestions. ** *`suggest_mode` (Optional, Enum("missing" | "popular" | "always"))*: Specify suggest mode ** *`suggest_size` (Optional, number)*: How many suggestions to return in response ** *`suggest_text` (Optional, string)*: The source text for which the suggestions should be returned. ** *`typed_keys` (Optional, boolean)*: Specify whether aggregation and suggester names should be prefixed by their respective types in the response -** *`rest_total_hits_as_int` (Optional, boolean)* +** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether hits.total should be rendered as an integer or an object in the rest search response ** *`_source_excludes` (Optional, string | string[])*: A list of fields to exclude from the returned _source field ** *`_source_includes` (Optional, string | string[])*: A list of fields to extract and return from the _source field ** *`q` (Optional, string)*: Query in the Lucene query string syntax @@ -1507,6 +1535,10 @@ client.cat.componentTemplates({ ... }) * *Request (object):* ** *`name` (Optional, string)*: The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. +** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the +local cluster state. If `false` the list of selected nodes are computed +from the cluster state of the master node. In both cases the coordinating +node will send requests for further information to each selected node. [discrete] ==== count @@ -2827,7 +2859,6 @@ If the request can target data streams, this argument determines whether wildcar Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. ** *`ignore_unavailable` (Optional, boolean)*: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. -** *`local` (Optional, boolean)*: If `true`, the request retrieves information from the local node only. [discrete] ==== exists_index_template @@ -2924,7 +2955,6 @@ If the request can target data streams, this argument determines whether wildcar Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. ** *`ignore_unavailable` (Optional, boolean)*: If `false`, the request returns an error if it targets a missing or closed index. -** *`local` (Optional, boolean)*: If `true`, the request retrieves information from the local node only. [discrete] ==== get_data_lifecycle @@ -3675,8 +3705,8 @@ client.ingest.putPipeline({ id }) ** *`id` (string)*: ID of the ingest pipeline to create or update. ** *`_meta` (Optional, Record)*: Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. ** *`description` (Optional, string)*: Description of the ingest pipeline. -** *`on_failure` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. -** *`processors` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. +** *`on_failure` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. +** *`processors` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. ** *`version` (Optional, number)*: Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. ** *`deprecated` (Optional, boolean)*: Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning. @@ -5646,7 +5676,7 @@ client.security.createApiKey({ ... }) * *Request (object):* ** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. By default, API keys never expire. ** *`name` (Optional, string)*: Specifies the name for this API key. -** *`role_descriptors` (Optional, Record)*: 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. +** *`role_descriptors` (Optional, Record)*: 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)*: 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. ** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. @@ -5754,7 +5784,7 @@ client.security.hasPrivileges({ ... }) * *Request (object):* ** *`user` (Optional, string)*: Username ** *`application` (Optional, { application, privileges, resources }[])* -** *`cluster` (Optional, Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])*: A list of the cluster privileges that you want to check. +** *`cluster` (Optional, Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_stats" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])*: A list of the cluster privileges that you want to check. ** *`index` (Optional, { names, privileges, allow_restricted_indices }[])* [discrete] @@ -5812,7 +5842,7 @@ client.security.putRole({ name }) * *Request (object):* ** *`name` (string)*: The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. ** *`applications` (Optional, { application, privileges, resources }[])*: A list of application privilege entries. -** *`cluster` (Optional, Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])*: A list of cluster privileges. These privileges define the cluster-level actions for users with this role. +** *`cluster` (Optional, Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_stats" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])*: A list of cluster privileges. These privileges define the cluster-level actions for users with this role. ** *`indices` (Optional, { field_security, names, privileges, query }[])*: A list of indices permissions entries. ** *`metadata` (Optional, Record)*: Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use. ** *`run_as` (Optional, string[])*: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. @@ -5890,7 +5920,7 @@ client.security.updateApiKey({ id }) * *Request (object):* ** *`id` (string)*: The ID of the API key to update. -** *`role_descriptors` (Optional, Record)*: 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. +** *`role_descriptors` (Optional, Record)*: 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)*: 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. diff --git a/src/api/api/async_search.ts b/src/api/api/async_search.ts index f17bb56..f0c8523 100644 --- a/src/api/api/async_search.ts +++ b/src/api/api/async_search.ts @@ -109,7 +109,7 @@ export default class AsyncSearch { } /** - * Get async search status. Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + * Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html | Elasticsearch API documentation} */ async status (this: That, params: T.AsyncSearchStatusRequest | TB.AsyncSearchStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/clear_scroll.ts b/src/api/api/clear_scroll.ts index 7c4848d..5fa4116 100644 --- a/src/api/api/clear_scroll.ts +++ b/src/api/api/clear_scroll.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Clears the search context and results for a scrolling search. + * Clear a scrolling search. Clear the search context and results for a scrolling search. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-scroll-api.html | Elasticsearch API documentation} */ export default async function ClearScrollApi (this: That, params?: T.ClearScrollRequest | TB.ClearScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/close_point_in_time.ts b/src/api/api/close_point_in_time.ts index c4c779e..f143461 100644 --- a/src/api/api/close_point_in_time.ts +++ b/src/api/api/close_point_in_time.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Closes a point-in-time. + * Close a point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the `keep_alive` period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html | Elasticsearch API documentation} */ export default async function ClosePointInTimeApi (this: That, params: T.ClosePointInTimeRequest | TB.ClosePointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/field_caps.ts b/src/api/api/field_caps.ts index 7a2c5bc..082e83a 100644 --- a/src/api/api/field_caps.ts +++ b/src/api/api/field_caps.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * The field capabilities API returns the information about the capabilities of fields among multiple indices. The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family. + * Get the field capabilities. Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html | Elasticsearch API documentation} */ export default async function FieldCapsApi (this: That, params?: T.FieldCapsRequest | TB.FieldCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/msearch_template.ts b/src/api/api/msearch_template.ts index a1897a4..2e33d92 100644 --- a/src/api/api/msearch_template.ts +++ b/src/api/api/msearch_template.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Runs multiple templated searches with a single request. + * Run multiple templated searches. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html | Elasticsearch API documentation} */ export default async function MsearchTemplateApi> (this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise> diff --git a/src/api/api/open_point_in_time.ts b/src/api/api/open_point_in_time.ts index 69aabd1..0a01763 100644 --- a/src/api/api/open_point_in_time.ts +++ b/src/api/api/open_point_in_time.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * A search request by default executes against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. + * Open a point in time. A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html | Elasticsearch API documentation} */ export default async function OpenPointInTimeApi (this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/rank_eval.ts b/src/api/api/rank_eval.ts index 010a984..4405222 100644 --- a/src/api/api/rank_eval.ts +++ b/src/api/api/rank_eval.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Enables you to evaluate the quality of ranked search results over a set of typical search queries. + * Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html | Elasticsearch API documentation} */ export default async function RankEvalApi (this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/render_search_template.ts b/src/api/api/render_search_template.ts index cd31ab4..d3d5ad4 100644 --- a/src/api/api/render_search_template.ts +++ b/src/api/api/render_search_template.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Renders a search template as a search request body. + * Render a search template. Render a search template as a search request body. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/render-search-template-api.html | Elasticsearch API documentation} */ export default async function RenderSearchTemplateApi (this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/search.ts b/src/api/api/search.ts index 1827183..226e3d1 100644 --- a/src/api/api/search.ts +++ b/src/api/api/search.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Returns search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. + * Run a search. Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html | Elasticsearch API documentation} */ export default async function SearchApi> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise> diff --git a/src/api/api/search_mvt.ts b/src/api/api/search_mvt.ts index 6d2f125..3311d22 100644 --- a/src/api/api/search_mvt.ts +++ b/src/api/api/search_mvt.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Search a vector tile. Searches a vector tile for geospatial values. + * Search a vector tile. Search a vector tile for geospatial values. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html | Elasticsearch API documentation} */ export default async function SearchMvtApi (this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/api/search_template.ts b/src/api/api/search_template.ts index a158ad5..be504ab 100644 --- a/src/api/api/search_template.ts +++ b/src/api/api/search_template.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Runs a search with a search template. + * Run a search with a search template. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html | Elasticsearch API documentation} */ export default async function SearchTemplateApi (this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise> diff --git a/src/api/api/termvectors.ts b/src/api/api/termvectors.ts index 3e8c120..f47ff74 100644 --- a/src/api/api/termvectors.ts +++ b/src/api/api/termvectors.ts @@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey' interface That { transport: Transport } /** - * Get term vector information. Returns information and statistics about terms in the fields of a particular document. + * Get term vector information. Get information and statistics about terms in the fields of a particular document. * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html | Elasticsearch API documentation} */ export default async function TermvectorsApi (this: That, params: T.TermvectorsRequest | TB.TermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise diff --git a/src/api/types.ts b/src/api/types.ts index d491444..1f33dae 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -497,6 +497,15 @@ export interface HealthReportDiskIndicatorDetails { nodes_with_unknown_disk_status: long } +export interface HealthReportFileSettingsIndicator extends HealthReportBaseIndicator { + details?: HealthReportFileSettingsIndicatorDetails +} + +export interface HealthReportFileSettingsIndicatorDetails { + failure_streak: long + most_recent_failure: string +} + export interface HealthReportIlmIndicator extends HealthReportBaseIndicator { details?: HealthReportIlmIndicatorDetails } @@ -532,6 +541,7 @@ export interface HealthReportIndicators { ilm?: HealthReportIlmIndicator slm?: HealthReportSlmIndicator shards_capacity?: HealthReportShardsCapacityIndicator + file_settings?: HealthReportFileSettingsIndicator } export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { @@ -882,6 +892,7 @@ export interface OpenPointInTimeRequest extends RequestBase { preference?: string routing?: Routing expand_wildcards?: ExpandWildcards + allow_partial_search_results?: boolean index_filter?: QueryDslQueryContainer } @@ -1154,7 +1165,6 @@ export interface SearchRequest extends RequestBase { include_named_queries_score?: boolean lenient?: boolean max_concurrent_shard_requests?: long - min_compatible_shard_node?: VersionString preference?: string pre_filter_shard_size?: long request_cache?: boolean @@ -2632,6 +2642,7 @@ export interface RetrieverContainer { knn?: KnnRetriever rrf?: RRFRetriever text_similarity_reranker?: TextSimilarityReranker + rule?: RuleRetriever } export type Routing = string @@ -2641,6 +2652,13 @@ export interface RrfRank { rank_window_size?: long } +export interface RuleRetriever extends RetrieverBase { + ruleset_ids: Id[] + match_criteria: any + retriever: RetrieverContainer + rank_window_size?: integer +} + export type ScalarValue = long | double | string | boolean | null export interface ScoreSort { @@ -6650,6 +6668,7 @@ export type AsyncSearchGetResponse @@ -12084,7 +12115,6 @@ export interface IndicesSegmentsRequest extends RequestBase { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean - verbose?: boolean } export interface IndicesSegmentsResponse { @@ -12781,6 +12811,16 @@ export interface IngestInferenceProcessor extends IngestProcessorBase { inference_config?: IngestInferenceConfig } +export interface IngestIpLocationProcessor extends IngestProcessorBase { + database_file?: string + field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field + download_database_on_pipeline_creation?: boolean +} + export interface IngestJoinProcessor extends IngestProcessorBase { field: Field separator: string @@ -12875,6 +12915,7 @@ export interface IngestProcessorContainer { fail?: IngestFailProcessor fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor + ip_location?: IngestIpLocationProcessor geo_grid?: IngestGeoGridProcessor geoip?: IngestGeoIpProcessor grok?: IngestGrokProcessor @@ -13330,6 +13371,7 @@ export interface MigrationDeprecationsRequest extends RequestBase { export interface MigrationDeprecationsResponse { cluster_settings: MigrationDeprecationsDeprecation[] index_settings: Record + data_streams: Record node_settings: MigrationDeprecationsDeprecation[] ml_settings: MigrationDeprecationsDeprecation[] } @@ -16832,6 +16874,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem { ruleset_id: Id rule_total_count: integer rule_criteria_types_counts: Record + rule_type_counts: Record } export interface QueryRulesListRulesetsRequest extends RequestBase { @@ -17223,22 +17266,32 @@ export interface SearchableSnapshotsStatsResponse { total: any } +export interface SecurityAccess { + replication?: SecurityReplicationAccess[] + search?: SecuritySearchAccess[] +} + export interface SecurityApiKey { - creation?: long - expiration?: long id: Id - invalidated?: boolean name: Name - realm?: string + type: SecurityApiKeyType + creation: EpochTime + expiration?: EpochTime + invalidated: boolean + invalidation?: EpochTime + username: Username + realm: string realm_type?: string - username?: Username - profile_uid?: string - metadata?: Metadata + metadata: Metadata role_descriptors?: Record limited_by?: Record[] + access?: SecurityAccess + profile_uid?: string _sort?: SortResults } +export type SecurityApiKeyType = 'rest' | 'cross_cluster' + export interface SecurityApplicationGlobalUserPrivileges { manage: SecurityManageUserPrivileges } @@ -17258,7 +17311,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string export interface SecurityCreatedStatus { created: boolean @@ -17285,7 +17338,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea export interface SecurityIndicesPrivileges { field_security?: SecurityFieldSecurity - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery } @@ -17301,14 +17354,32 @@ export interface SecurityRealmInfo { type: string } +export type SecurityRemoteClusterPrivilege = 'monitor_enrich' | 'monitor_stats' + +export interface SecurityRemoteClusterPrivileges { + clusters: Names + privileges: SecurityRemoteClusterPrivilege[] +} + export interface SecurityRemoteIndicesPrivileges { clusters: Names field_security?: SecurityFieldSecurity - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery } +export interface SecurityReplicationAccess { + names: IndexName | IndexName[] + allow_restricted_indices?: boolean +} + +export interface SecurityRestriction { + workflows: SecurityRestrictionWorkflow[] +} + +export type SecurityRestrictionWorkflow = 'search_application_query' | string + export interface SecurityRoleDescriptor { cluster?: SecurityClusterPrivilege[] indices?: SecurityIndicesPrivileges[] @@ -17317,6 +17388,7 @@ export interface SecurityRoleDescriptor { metadata?: Metadata run_as?: string[] description?: string + restriction?: SecurityRestriction transient_metadata?: Record } @@ -17328,6 +17400,7 @@ export interface SecurityRoleDescriptorRead { metadata?: Metadata run_as?: string[] description?: string + restriction?: SecurityRestriction transient_metadata?: Record } @@ -17365,6 +17438,12 @@ export interface SecurityRoleTemplateScript { options?: Record } +export interface SecuritySearchAccess { + field_security?: SecurityFieldSecurity + names: IndexName | IndexName[] + query?: SecurityIndicesPrivilegesQuery +} + export type SecurityTemplateFormat = 'string' | 'json' export interface SecurityUser { @@ -17379,7 +17458,7 @@ export interface SecurityUser { export interface SecurityUserIndicesPrivileges { field_security?: SecurityFieldSecurity[] - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery[] allow_restricted_indices: boolean @@ -17423,11 +17502,16 @@ export interface SecurityActivateUserProfileRequest extends RequestBase { export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata +export interface SecurityAuthenticateAuthenticateApiKey { + id: Id + name?: Name +} + export interface SecurityAuthenticateRequest extends RequestBase { } export interface SecurityAuthenticateResponse { - api_key?: SecurityApiKey + api_key?: SecurityAuthenticateAuthenticateApiKey authentication_realm: SecurityRealmInfo email?: string | null full_name?: Name | null @@ -17547,6 +17631,21 @@ export interface SecurityCreateApiKeyResponse { encoded: string } +export interface SecurityCreateCrossClusterApiKeyRequest extends RequestBase { + access: SecurityAccess + expiration?: Duration + metadata?: Metadata + name: Name +} + +export interface SecurityCreateCrossClusterApiKeyResponse { + api_key: string + expiration?: DurationValue + id: Id + name: Name + encoded: string +} + export interface SecurityCreateServiceTokenRequest extends RequestBase { namespace: Namespace service: Service @@ -17688,7 +17787,7 @@ export interface SecurityGetBuiltinPrivilegesRequest extends RequestBase { } export interface SecurityGetBuiltinPrivilegesResponse { - cluster: string[] + cluster: SecurityClusterPrivilege[] index: IndexName[] } @@ -17706,7 +17805,7 @@ export interface SecurityGetRoleRequest extends RequestBase { export type SecurityGetRoleResponse = Record export interface SecurityGetRoleRole { - cluster: string[] + cluster: SecurityClusterPrivilege[] indices: SecurityIndicesPrivileges[] metadata: Metadata run_as: string[] @@ -18223,6 +18322,17 @@ export interface SecurityUpdateApiKeyResponse { updated: boolean } +export interface SecurityUpdateCrossClusterApiKeyRequest extends RequestBase { + id: Id + access: SecurityAccess + expiration?: Duration + metadata?: Metadata +} + +export interface SecurityUpdateCrossClusterApiKeyResponse { + updated: boolean +} + export interface SecurityUpdateUserProfileDataRequest extends RequestBase { uid: SecurityUserProfileId if_seq_no?: SequenceNumber @@ -19064,7 +19174,7 @@ export interface TasksListRequest extends RequestBase { actions?: string | string[] detailed?: boolean group_by?: TasksGroupBy - node_id?: string[] + nodes?: NodeIds parent_task_id?: Id master_timeout?: Duration timeout?: Duration @@ -19781,6 +19891,7 @@ export interface WatcherReportingEmailAttachment { export type WatcherResponseContentType = 'json' | 'yaml' | 'text' export interface WatcherScheduleContainer { + timezone?: string cron?: WatcherCronExpression daily?: WatcherDailySchedule hourly?: WatcherHourlySchedule @@ -20136,6 +20247,7 @@ export interface XpackInfoFeatures { graph: XpackInfoFeature ilm: XpackInfoFeature logstash: XpackInfoFeature + logsdb: XpackInfoFeature ml: XpackInfoFeature monitoring: XpackInfoFeature rollup: XpackInfoFeature @@ -20630,7 +20742,6 @@ export interface SpecUtilsCommonCatQueryParameters { format?: string h?: Names help?: boolean - local?: boolean master_timeout?: Duration s?: Names v?: boolean diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index 7f1d24d..93b9009 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -518,6 +518,15 @@ export interface HealthReportDiskIndicatorDetails { nodes_with_unknown_disk_status: long } +export interface HealthReportFileSettingsIndicator extends HealthReportBaseIndicator { + details?: HealthReportFileSettingsIndicatorDetails +} + +export interface HealthReportFileSettingsIndicatorDetails { + failure_streak: long + most_recent_failure: string +} + export interface HealthReportIlmIndicator extends HealthReportBaseIndicator { details?: HealthReportIlmIndicatorDetails } @@ -553,6 +562,7 @@ export interface HealthReportIndicators { ilm?: HealthReportIlmIndicator slm?: HealthReportSlmIndicator shards_capacity?: HealthReportShardsCapacityIndicator + file_settings?: HealthReportFileSettingsIndicator } export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator { @@ -915,6 +925,7 @@ export interface OpenPointInTimeRequest extends RequestBase { preference?: string routing?: Routing expand_wildcards?: ExpandWildcards + allow_partial_search_results?: boolean /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ body?: { index_filter?: QueryDslQueryContainer @@ -1209,7 +1220,6 @@ export interface SearchRequest extends RequestBase { include_named_queries_score?: boolean lenient?: boolean max_concurrent_shard_requests?: long - min_compatible_shard_node?: VersionString preference?: string pre_filter_shard_size?: long request_cache?: boolean @@ -2708,6 +2718,7 @@ export interface RetrieverContainer { knn?: KnnRetriever rrf?: RRFRetriever text_similarity_reranker?: TextSimilarityReranker + rule?: RuleRetriever } export type Routing = string @@ -2717,6 +2728,13 @@ export interface RrfRank { rank_window_size?: long } +export interface RuleRetriever extends RetrieverBase { + ruleset_ids: Id[] + match_criteria: any + retriever: RetrieverContainer + rank_window_size?: integer +} + export type ScalarValue = long | double | string | boolean | null export interface ScoreSort { @@ -6726,6 +6744,7 @@ export type AsyncSearchGetResponse @@ -12291,7 +12322,6 @@ export interface IndicesSegmentsRequest extends RequestBase { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean - verbose?: boolean } export interface IndicesSegmentsResponse { @@ -13007,6 +13037,16 @@ export interface IngestInferenceProcessor extends IngestProcessorBase { inference_config?: IngestInferenceConfig } +export interface IngestIpLocationProcessor extends IngestProcessorBase { + database_file?: string + field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field + download_database_on_pipeline_creation?: boolean +} + export interface IngestJoinProcessor extends IngestProcessorBase { field: Field separator: string @@ -13101,6 +13141,7 @@ export interface IngestProcessorContainer { fail?: IngestFailProcessor fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor + ip_location?: IngestIpLocationProcessor geo_grid?: IngestGeoGridProcessor geoip?: IngestGeoIpProcessor grok?: IngestGrokProcessor @@ -13569,6 +13610,7 @@ export interface MigrationDeprecationsRequest extends RequestBase { export interface MigrationDeprecationsResponse { cluster_settings: MigrationDeprecationsDeprecation[] index_settings: Record + data_streams: Record node_settings: MigrationDeprecationsDeprecation[] ml_settings: MigrationDeprecationsDeprecation[] } @@ -17188,6 +17230,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem { ruleset_id: Id rule_total_count: integer rule_criteria_types_counts: Record + rule_type_counts: Record } export interface QueryRulesListRulesetsRequest extends RequestBase { @@ -17601,22 +17644,32 @@ export interface SearchableSnapshotsStatsResponse { total: any } +export interface SecurityAccess { + replication?: SecurityReplicationAccess[] + search?: SecuritySearchAccess[] +} + export interface SecurityApiKey { - creation?: long - expiration?: long id: Id - invalidated?: boolean name: Name - realm?: string + type: SecurityApiKeyType + creation: EpochTime + expiration?: EpochTime + invalidated: boolean + invalidation?: EpochTime + username: Username + realm: string realm_type?: string - username?: Username - profile_uid?: string - metadata?: Metadata + metadata: Metadata role_descriptors?: Record limited_by?: Record[] + access?: SecurityAccess + profile_uid?: string _sort?: SortResults } +export type SecurityApiKeyType = 'rest' | 'cross_cluster' + export interface SecurityApplicationGlobalUserPrivileges { manage: SecurityManageUserPrivileges } @@ -17636,7 +17689,7 @@ export interface SecurityClusterNode { name: Name } -export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string export interface SecurityCreatedStatus { created: boolean @@ -17663,7 +17716,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea export interface SecurityIndicesPrivileges { field_security?: SecurityFieldSecurity - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery } @@ -17679,14 +17732,32 @@ export interface SecurityRealmInfo { type: string } +export type SecurityRemoteClusterPrivilege = 'monitor_enrich' | 'monitor_stats' + +export interface SecurityRemoteClusterPrivileges { + clusters: Names + privileges: SecurityRemoteClusterPrivilege[] +} + export interface SecurityRemoteIndicesPrivileges { clusters: Names field_security?: SecurityFieldSecurity - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery } +export interface SecurityReplicationAccess { + names: IndexName | IndexName[] + allow_restricted_indices?: boolean +} + +export interface SecurityRestriction { + workflows: SecurityRestrictionWorkflow[] +} + +export type SecurityRestrictionWorkflow = 'search_application_query' | string + export interface SecurityRoleDescriptor { cluster?: SecurityClusterPrivilege[] indices?: SecurityIndicesPrivileges[] @@ -17695,6 +17766,7 @@ export interface SecurityRoleDescriptor { metadata?: Metadata run_as?: string[] description?: string + restriction?: SecurityRestriction transient_metadata?: Record } @@ -17706,6 +17778,7 @@ export interface SecurityRoleDescriptorRead { metadata?: Metadata run_as?: string[] description?: string + restriction?: SecurityRestriction transient_metadata?: Record } @@ -17743,6 +17816,12 @@ export interface SecurityRoleTemplateScript { options?: Record } +export interface SecuritySearchAccess { + field_security?: SecurityFieldSecurity + names: IndexName | IndexName[] + query?: SecurityIndicesPrivilegesQuery +} + export type SecurityTemplateFormat = 'string' | 'json' export interface SecurityUser { @@ -17757,7 +17836,7 @@ export interface SecurityUser { export interface SecurityUserIndicesPrivileges { field_security?: SecurityFieldSecurity[] - names: IndexName[] + names: IndexName | IndexName[] privileges: SecurityIndexPrivilege[] query?: SecurityIndicesPrivilegesQuery[] allow_restricted_indices: boolean @@ -17804,11 +17883,16 @@ export interface SecurityActivateUserProfileRequest extends RequestBase { export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata +export interface SecurityAuthenticateAuthenticateApiKey { + id: Id + name?: Name +} + export interface SecurityAuthenticateRequest extends RequestBase { } export interface SecurityAuthenticateResponse { - api_key?: SecurityApiKey + api_key?: SecurityAuthenticateAuthenticateApiKey authentication_realm: SecurityRealmInfo email?: string | null full_name?: Name | null @@ -17940,6 +18024,24 @@ export interface SecurityCreateApiKeyResponse { encoded: string } +export interface SecurityCreateCrossClusterApiKeyRequest extends RequestBase { + /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ + body?: { + access: SecurityAccess + expiration?: Duration + metadata?: Metadata + name: Name + } +} + +export interface SecurityCreateCrossClusterApiKeyResponse { + api_key: string + expiration?: DurationValue + id: Id + name: Name + encoded: string +} + export interface SecurityCreateServiceTokenRequest extends RequestBase { namespace: Namespace service: Service @@ -18081,7 +18183,7 @@ export interface SecurityGetBuiltinPrivilegesRequest extends RequestBase { } export interface SecurityGetBuiltinPrivilegesResponse { - cluster: string[] + cluster: SecurityClusterPrivilege[] index: IndexName[] } @@ -18099,7 +18201,7 @@ export interface SecurityGetRoleRequest extends RequestBase { export type SecurityGetRoleResponse = Record export interface SecurityGetRoleRole { - cluster: string[] + cluster: SecurityClusterPrivilege[] indices: SecurityIndicesPrivileges[] metadata: Metadata run_as: string[] @@ -18675,6 +18777,20 @@ export interface SecurityUpdateApiKeyResponse { updated: boolean } +export interface SecurityUpdateCrossClusterApiKeyRequest extends RequestBase { + id: Id + /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ + body?: { + access: SecurityAccess + expiration?: Duration + metadata?: Metadata + } +} + +export interface SecurityUpdateCrossClusterApiKeyResponse { + updated: boolean +} + export interface SecurityUpdateUserProfileDataRequest extends RequestBase { uid: SecurityUserProfileId if_seq_no?: SequenceNumber @@ -19550,7 +19666,7 @@ export interface TasksListRequest extends RequestBase { actions?: string | string[] detailed?: boolean group_by?: TasksGroupBy - node_id?: string[] + nodes?: NodeIds parent_task_id?: Id master_timeout?: Duration timeout?: Duration @@ -20280,6 +20396,7 @@ export interface WatcherReportingEmailAttachment { export type WatcherResponseContentType = 'json' | 'yaml' | 'text' export interface WatcherScheduleContainer { + timezone?: string cron?: WatcherCronExpression daily?: WatcherDailySchedule hourly?: WatcherHourlySchedule @@ -20644,6 +20761,7 @@ export interface XpackInfoFeatures { graph: XpackInfoFeature ilm: XpackInfoFeature logstash: XpackInfoFeature + logsdb: XpackInfoFeature ml: XpackInfoFeature monitoring: XpackInfoFeature rollup: XpackInfoFeature @@ -21138,7 +21256,6 @@ export interface SpecUtilsCommonCatQueryParameters { format?: string h?: Names help?: boolean - local?: boolean master_timeout?: Duration s?: Names v?: boolean