From 67a4a2d00bf6e76fa10ac839d999389dbee42f25 Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Wed, 23 Jul 2025 16:28:24 +0100 Subject: [PATCH 1/2] [API] Updates source code docs, spec commit 896e37f76add4e8878e9f04205dd8628c7263219 --- .../elasticsearch/api/actions/cat/recovery.rb | 7 +++-- .../elasticsearch/api/actions/cat/segments.rb | 5 ++-- .../elasticsearch/api/actions/cat/shards.rb | 6 ++-- .../api/actions/cat/snapshots.rb | 3 +- .../api/actions/cat/thread_pool.rb | 4 +-- .../actions/cluster/get_component_template.rb | 1 + .../actions/cluster/put_component_template.rb | 1 + .../lib/elasticsearch/api/actions/create.rb | 8 ----- .../elasticsearch/api/actions/eql/search.rb | 5 ++-- .../elasticsearch/api/actions/get_source.rb | 1 - .../lib/elasticsearch/api/actions/index.rb | 1 + .../api/actions/indices/recovery.rb | 6 ++++ .../api/actions/inference/put.rb | 1 + .../api/actions/inference/put_alibabacloud.rb | 1 + .../actions/inference/put_amazonbedrock.rb | 1 + .../api/actions/inference/put_anthropic.rb | 1 + .../actions/inference/put_azureaistudio.rb | 1 + .../api/actions/inference/put_azureopenai.rb | 1 + .../api/actions/inference/put_cohere.rb | 1 + .../actions/inference/put_elasticsearch.rb | 1 + .../api/actions/inference/put_elser.rb | 1 + .../actions/inference/put_googleaistudio.rb | 1 + .../actions/inference/put_googlevertexai.rb | 1 + .../api/actions/inference/put_hugging_face.rb | 1 + .../api/actions/inference/put_jinaai.rb | 1 + .../api/actions/inference/put_mistral.rb | 1 + .../api/actions/inference/put_openai.rb | 1 + .../api/actions/inference/put_voyageai.rb | 1 + .../api/actions/inference/put_watsonx.rb | 1 + .../api/actions/inference/rerank.rb | 2 +- .../actions/inference/stream_completion.rb | 1 + .../ingest/get_ip_location_database.rb | 3 -- .../api/actions/license/post_start_trial.rb | 2 +- .../update_data_frame_analytics.rb | 2 +- .../lib/elasticsearch/api/actions/reindex.rb | 3 ++ .../elasticsearch/api/actions/search_mvt.rb | 3 ++ .../actions/security/get_user_privileges.rb | 3 -- .../api/actions/security/grant_api_key.rb | 4 +++ .../api/actions/snapshot/delete.rb | 2 ++ .../api/actions/synonyms/put_synonym.rb | 1 + .../lib/elasticsearch/api/actions/update.rb | 1 + .../api/actions/update_by_query.rb | 30 ++++++++++++------- .../lib/elasticsearch/api/version.rb | 2 +- 43 files changed, 81 insertions(+), 43 deletions(-) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index e69fc3348d..b5f1672346 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -33,11 +33,12 @@ module Actions # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries. # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. - # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. - # @option arguments [String] :time Unit used to display time values. + # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 4fbeaac85b..7c446237ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -31,8 +31,9 @@ module Actions # Supports wildcards (`*`). # To target all data streams and indices, omit this parameter or use `*` or `_all`. # @option arguments [String] :bytes The unit used to display byte values. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. - # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index d31da8ade7..4ee2e2196d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -32,11 +32,11 @@ module Actions # To target all data streams and indices, omit this parameter or use `*` or `_all`. # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. - # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. - # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String] :time Unit used to display time values. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 7d8b3c20d2..d5b83ead0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -32,7 +32,8 @@ module Actions # `_all` returns all repositories. # If any repository fails during the request, Elasticsearch returns an error. # @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index 3962af5cb8..bbe195c06b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -30,7 +30,7 @@ module Actions # @option arguments [String, Array] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request. # Accepts wildcard expressions. # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. - # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. # @option arguments [String] :time The unit used to display time values. @@ -38,7 +38,7 @@ module Actions # 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. - # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index 7e64db0de6..7c55d33324 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -28,6 +28,7 @@ module Actions # @option arguments [String] :name Comma-separated list of component template names used to limit the request. # Wildcard (`*`) expressions are supported. # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [String, Array] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false) # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. # If `false`, information is retrieved from the master node. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index de794b43a5..7253562369 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -43,6 +43,7 @@ module Actions # If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. # If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. (*Required*) # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing component templates. + # @option arguments [String] :cause User defined reason for create the component template. Server default: api. # @option arguments [Time] :master_timeout 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. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index 4caa9a0ca4..d2b996b1ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -77,15 +77,7 @@ module Actions # @option arguments [String] :index The name of the data stream or index to target. # If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. # If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*) - # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term. - # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number. # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true. - # @option arguments [String] :op_type Set to `create` to only index the document if it does not already exist (put if absent). - # If a document with the specified `_id` already exists, the indexing operation will fail. - # The behavior is the same as using the `/_create` endpoint. - # If a document ID is specified, this paramater defaults to `index`. - # Otherwise, it defaults to `create`. - # If the request targets a data stream, an `op_type` of `create` is required. # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents. # If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. # If a final pipeline is configured, it will always run regardless of the value of this parameter. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 0ae93b7fd5..9307680c64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -27,11 +27,12 @@ module Actions # EQL assumes each document in a data stream or index corresponds to an event. # # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*) - # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true. + # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true. # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true. # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all. # This flag has effect only if allow_partial_search_results is true. - # @option arguments [String, Array] :expand_wildcards [TODO] Server default: open. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. + # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true. # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true. # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d. # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index 4c59c9ae99..e309490810 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -46,7 +46,6 @@ module Actions # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude in the response. # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. - # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit. # @option arguments [Integer] :version The version number for concurrency control. # It must match the current version of the document for the request to succeed. # @option arguments [String] :version_type The version type. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index efdc0f293b..8f73eb51f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -138,6 +138,7 @@ module Actions # You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). # The default value of `1` means it waits for each primary shard to be active. Server default: 1. # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. + # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created). # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index 0d61cc9d0e..936848c450 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -45,6 +45,12 @@ module Actions # To target all data streams and indices, omit this parameter or use `*` or `_all`. # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries. # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. + # @option arguments [Boolean] :allow_no_indices 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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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 comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index be80fb4220..44b374b5b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -46,6 +46,7 @@ module Actions # # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types. # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb index edab9d0ece..1eedcfa206 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb index 64d1cf1fef..9910568755 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :amazonbedrock_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb index eecfacdf8d..91d58a6015 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -28,6 +28,7 @@ module Actions # @option arguments [String] :task_type The task type. # The only valid task type for the model to perform is `completion`. (*Required*) # @option arguments [String] :anthropic_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb index b7d7465ee2..7cb06dee8f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :azureaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb index e07ecc3845..0cd5e073fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -32,6 +32,7 @@ module Actions # @option arguments [String] :task_type The type of the inference task that the model will perform. # NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*) # @option arguments [String] :azureopenai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb index 0e4e01db16..cee5cdf5a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :cohere_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb index 806bc55af3..4ea12f6907 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -28,6 +28,7 @@ module Actions # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :elasticsearch_inference_id The unique identifier of the inference endpoint. # The must not match the `model_id`. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb index 07548ca172..00e4af60d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -28,6 +28,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :elser_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb index 82a751dba3..840bf4e7c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :googleaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb index f9b37d1710..7fec9214e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -27,6 +27,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :googlevertexai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb index 940cabc8e3..e4928013da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb @@ -38,6 +38,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :huggingface_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb index fcf737f287..e36d666394 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -29,6 +29,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :jinaai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb index b582f5ddac..c551b8df82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -28,6 +28,7 @@ module Actions # @option arguments [String] :task_type The task type. # The only valid task type for the model to perform is `text_embedding`. (*Required*) # @option arguments [String] :mistral_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb index a6f3114bef..a4c73acd61 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -28,6 +28,7 @@ module Actions # @option arguments [String] :task_type The type of the inference task that the model will perform. # NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*) # @option arguments [String] :openai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb index 4002abe43e..e00b049734 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -28,6 +28,7 @@ module Actions # # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) # @option arguments [String] :voyageai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb index 5543cc6172..9fca1baff7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -30,6 +30,7 @@ module Actions # @option arguments [String] :task_type The task type. # The only valid task type for the model to perform is `text_embedding`. (*Required*) # @option arguments [String] :watsonx_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb index 3eed6b0ed3..bdf90ef57a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform rereanking inference on the service + # Perform reranking inference on the service # # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb index dc97c489f8..715360042e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -29,6 +29,7 @@ module Actions # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. # # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) + # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb index 731d47e511..4124fc079f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb @@ -27,9 +27,6 @@ module Actions # @option arguments [String, Array] :id Comma-separated list of database configuration IDs to retrieve. # Wildcard (`*`) expressions are supported. # To get all database configurations, omit this parameter or use `*`. - # @option arguments [Time] :master_timeout The 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. - # A value of `-1` indicates that the request should never time out. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb index b6e75fa1c6..f0ae40da9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -29,7 +29,7 @@ module Actions # To check the status of your trial, use the get trial status API. # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) - # @option arguments [String] :type_query_string [TODO] + # @option arguments [String] :type The type of trial license to generate (default: "trial") # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb index 75baf7dd34..3c1f82ac03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -41,7 +41,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-data-frame-analytics + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics # def update_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 5f50cfb11f..192c1ce780 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -62,6 +62,9 @@ module Actions # This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.NOTE: Reindexing from remote clusters does not support manual or automatic slicing.If set to `auto`, Elasticsearch chooses the number of slices to use. # This setting will use one slice per shard, up to a certain limit. # If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. Server default: 1. + # @option arguments [Integer] :max_docs The maximum number of documents to reindex. + # By default, all documents are reindexed. + # If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. # @option arguments [Time] :timeout The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. # By default, Elasticsearch waits for at least one minute before failing. # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb index 357cf66775..f2ebc99452 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb @@ -117,6 +117,9 @@ module Actions # of the cell. Server default: grid. # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000. # If 0, results don't include the hits layer. Server default: 10000. + # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately. + # If `true`, the exact number of hits is returned at the cost of some performance. + # If `false`, the response does not include the total number of hits matching the query. Server default: 10000. # @option arguments [Boolean] :with_labels If `true`, the hits and aggs layers will contain additional point features representing # suggested label positions for the original features. # - `Point` and `MultiPoint` features will have one of the points selected. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb index 4b05553c99..ed86b30af0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb @@ -28,9 +28,6 @@ module Actions # To check the privileges of other users, you must use the run as feature. # To check whether a user has a specific list of privileges, use the has privileges API. # - # @option arguments [String] :application The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. - # @option arguments [String] :priviledge The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. - # @option arguments [String, nil] :username [TODO] # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb index bd54d17c8d..f5bf7d4bf2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -39,6 +39,10 @@ module Actions # If applicable, it also returns expiration information for the API key in milliseconds. # By default, API keys never expire. You can specify expiration information when you create the API keys. # + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation + # visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', nothing is done with refreshes. Server default: false. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index 1dc390c590..3cdea51341 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -30,6 +30,8 @@ module Actions # @option arguments [Time] :master_timeout The period to wait for the master node. # If the master node is not available before the timeout expires, the request fails and returns an error. # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the matching snapshots are all deleted. + # If `false`, the request returns a response as soon as the deletes are scheduled. Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index 9454b12313..3785feca87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -27,6 +27,7 @@ module Actions # If you need to manage more synonym rules, you can create multiple synonym sets. # When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. # This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. + # For practical examples of how to create or update a synonyms set, refer to the External documentation. # # @option arguments [String] :id The ID of the synonyms set to be created or updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index d095974469..bfb99599c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -34,6 +34,7 @@ module Actions # The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation. # The `_source` field must be enabled to use this API. # In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). + # For usage examples such as partial updates, upserts, and scripted updates, see the External documentation. # # @option arguments [String] :id A unique identifier for the document to be updated. (*Required*) # @option arguments [String] :index The name of the target index. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index 9888c19320..25ceae015a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -38,6 +38,24 @@ module Actions # A bulk update request is performed for each batch of matching documents. # Any query or update failures cause the update by query request to fail and the failures are shown in the response. # Any update requests that completed successfully still stick, they are not rolled back. + # **Refreshing shards** + # Specifying the `refresh` parameter refreshes all shards once the request completes. + # This is different to the update API's `refresh` parameter, which causes only the shard + # that received the request to be refreshed. Unlike the update API, it does not support + # `wait_for`. + # **Running update by query asynchronously** + # If the request contains `wait_for_completion=false`, Elasticsearch + # performs some preflight checks, launches the request, and returns a + # {https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks task} you can use to cancel or get the status of the task. + # Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. + # **Waiting for active shards** + # `wait_for_active_shards` controls how many copies of a shard must be active + # before proceeding with the request. See {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards `wait_for_active_shards`} + # for details. `timeout` controls how long each write request waits for unavailable + # shards to become available. Both work exactly the way they work in the + # {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk Bulk API}. Update by query uses scrolled searches, so you can also + # specify the `scroll` parameter to control how long it keeps the search context + # alive, for example `?scroll=10m`. The default is 5 minutes. # **Throttling update requests** # To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. # This pads each batch with a wait time to throttle the rate. @@ -72,17 +90,7 @@ module Actions # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. # * Update performance scales linearly across available resources with the number of slices. # Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. - # **Update the document source** - # Update by query supports scripts to update the document source. - # As with the update API, you can set `ctx.op` to change the operation that is performed. - # Set `ctx.op = "noop"` if your script decides that it doesn't have to make any changes. - # The update by query operation skips updating the document and increments the `noop` counter. - # Set `ctx.op = "delete"` if your script decides that the document should be deleted. - # The update by query operation deletes the document and increments the `deleted` counter. - # Update by query supports only `index`, `noop`, and `delete`. - # Setting `ctx.op` to anything else is an error. - # Setting any other field in `ctx` is an error. - # This API enables you to only modify the source of matching documents; you cannot move them. + # Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API: # # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. # It supports wildcards (`*`). diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 18203a33c4..c116efbc72 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.0.3'.freeze - ES_SPECIFICATION_COMMIT = '6daaab336f97d5660f10ddd7a5bb7b7ea5c477c0'.freeze + ES_SPECIFICATION_COMMIT = '896e37f76add4e8878e9f04205dd8628c7263219'.freeze end end From d74c5c6df90a043a1731d4bd4b4ff14d43d43934 Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Wed, 23 Jul 2025 16:46:24 +0100 Subject: [PATCH 2/2] [CI] Updates STACK_VERSION to 9.0.3-SNAPSHOT --- .buildkite/pipeline.yml | 2 +- .github/workflows/9.0.yml | 4 ++-- .github/workflows/otel.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml index 13009e2f80..5d6e59e7fc 100644 --- a/.buildkite/pipeline.yml +++ b/.buildkite/pipeline.yml @@ -25,7 +25,7 @@ steps: transport: main env: RUBY_VERSION: '{{ matrix.ruby }}' - STACK_VERSION: 9.0.2-SNAPSHOT + STACK_VERSION: 9.0.3-SNAPSHOT ES_YAML_TESTS_BRANCH: '9.0' TRANSPORT_VERSION: '{{ matrix.transport }}' RUBY_SOURCE: '{{ matrix.ruby_source }}' diff --git a/.github/workflows/9.0.yml b/.github/workflows/9.0.yml index 492c154439..79370cd40f 100644 --- a/.github/workflows/9.0.yml +++ b/.github/workflows/9.0.yml @@ -26,7 +26,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 9.0.2-SNAPSHOT + stack-version: 9.0.3-SNAPSHOT - uses: ruby/setup-ruby@v1 with: ruby-version: ${{ matrix.ruby }} @@ -39,4 +39,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[9.0.2-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all + run: rake es:download_artifacts[9.0.3-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all diff --git a/.github/workflows/otel.yml b/.github/workflows/otel.yml index 1d7e4f927f..a34ee1f4d6 100644 --- a/.github/workflows/otel.yml +++ b/.github/workflows/otel.yml @@ -28,7 +28,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 9.0.2-SNAPSHOT + stack-version: 9.0.3-SNAPSHOT - uses: ruby/setup-ruby@v1 with: ruby-version: ${{ matrix.ruby }} @@ -41,4 +41,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[9.0.2-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all + run: rake es:download_artifacts[9.0.3-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all