[API] Updates source code to commit dc3690c592d7b3d1c8d238119e4fac01c6f91c90. Changes:

picandocodigo · picandocodigo · commit dbcbd7b04097 · 2025-07-09T17:08:47.000+01:00
* cluster.get_component_template - Adds [String] `:settings_filter` Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys.
* cluster.put_component_template - Adds [String] `:cause` User defined reason for create the component template. Server default: api.
* get, search - Add [Boolean] `:_source_exclude_vectors` Whether vectors should be excluded from _source,
get_source - removes stored_fields parameter
* index - Adds [Boolean] `:require_data_stream` If `true`, the request's actions must target a data stream (existing or to be created).
* license.post_start_trial - [String] `type_query_string` parameter renamed to `type`, The type of trial license to generate (default: "trial")
diff --git 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<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :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/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb
@@ -30,15 +30,15 @@ module Actions
         # @option arguments [String, Array<String>] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request.
         #  Accepts wildcard expressions.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :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.
         # @option arguments [Boolean] :local 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.
-        # @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
@@ -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<String>] :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
@@ -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/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb
@@ -88,6 +88,7 @@ module Actions
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
       #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
       #  If the `_source` parameter is `false`, this parameter is ignored.
+      # @option arguments [Boolean] :_source_exclude_vectors Whether vectors should be excluded from _source
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
       #  You can exclude fields from this subset using the `_source_excludes` query parameter.
diff --git 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<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [String, Array<String>] :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
@@ -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<String>] :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
@@ -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/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<String>] :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
@@ -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/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb
@@ -129,6 +129,7 @@ module Actions
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
       #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
       #  If the `_source` parameter is `false`, this parameter is ignored.
+      # @option arguments [Boolean] :_source_exclude_vectors Whether vectors should be excluded from _source
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
       #  You can exclude fields from this subset using the `_source_excludes` query parameter.
diff --git 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] :refresh If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
diff --git 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
@@ -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
@@ -18,6 +18,6 @@
 module Elasticsearch
   module API
     VERSION = '9.1.0'.freeze
-    ES_SPECIFICATION_COMMIT = '58fbe0ad87bb94a0870b7df4db76587fbfcaa5b7'.freeze
+    ES_SPECIFICATION_COMMIT = 'dc3690c592d7b3d1c8d238119e4fac01c6f91c90'.freeze
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ module Elasticsearch`
`22`	`22`	`module API`
`23`	`23`	`module Inference`
`24`	`24`	`module Actions`
`25`		`- # Perform rereanking inference on the service`
	`25`	`+ # Perform reranking inference on the service`
`26`	`26`	`#`
`27`	`27`	`# @option arguments [String] :inference_id The unique identifier for the inference endpoint. (Required)`
`28`	`28`	`# @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s.`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ module Actions`
`29`	`29`	`# To check the status of your trial, use the get trial status API.`
`30`	`30`	`#`
`31`	`31`	`# @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)`
`32`		`- # @option arguments [String] :type_query_string [TODO]`
	`32`	`+ # @option arguments [String] :type The type of trial license to generate (default: "trial")`
`33`	`33`	`# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.`
`34`	`34`	# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
`35`	`35`	`# when they occur.`