[API] Auto generated code, updates source code documentation

picandocodigo · picandocodigo · commit 69d5006cd8de · 2025-04-01T11:41:38.000+01:00
* esql.async_query, esql.query - Add Boolean parameter :allow_partial_results.
* indices.exists_index_template - Adds Boolean parameters: :local, :flat_settings.
* indices.field_usage_states - Removes :wait_for_active_shards parameter.
* indices.put_settings - Adds Boolean parameter :reopen.
* indices.reload_search_analyzers - Adds String parameter :resource.
* indices.rollover - Adds Boolean parameter :lazy.
* indices.simulate_index_template - Adds Boolean parameter :create and String parameter :cause.
* indices.simulate_template - Adds String parameter :cause.
* inference.chat_completion_unified - Argument body is now required.
* open_point_in_time - Adds Integer parameter :max_concurrent_shard_requests.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb
@@ -96,7 +96,7 @@ module Actions
       # @option arguments [String, Array<String>] :expand_wildcards The 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.
       #  It supports comma-separated values, such as +open,hidden+. Server default: open.
-      # @option arguments [Integer] :from Starting offset (default: 0)
+      # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0.
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
       # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
       #  This parameter can be used only when the +q+ query string parameter is specified.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb
@@ -26,6 +26,7 @@ module Actions
         # Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.
         # The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.
         #
+        # @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
         # @option arguments [String] :delimiter The character to use between values within a CSV row.
         #  It is valid only for the CSV format.
         # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb
@@ -32,6 +32,7 @@ module Actions
         # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
         # @option arguments [Boolean] :drop_null_columns Should columns that are entirely +null+ be removed from the +columns+ and +values+ portion of the results?
         #  Defaults to +false+. If +true+ then the response will include an extra section under the name +all_columns+ which has the name of all columns.
+        # @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb
@@ -63,7 +63,7 @@ def analyze(arguments = {})
                    else
                      '_analyze'
                    end
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb
@@ -26,6 +26,8 @@ module Actions
         # Check whether index templates exist.
         #
         # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (*Required*)
+        # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
+        # @option arguments [Boolean] :flat_settings If true, returns settings in flat format.
         # @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 [Hash] :headers Custom HTTP headers
         #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb
@@ -42,8 +42,6 @@ module Actions
         #  Supports comma-separated values, such as +open,hidden+.
         # @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.
         # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
-        # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
-        #  Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb
@@ -55,6 +55,9 @@ module Actions
         #  received before the timeout expires, the request fails and returns an
         #  error. Server default: 30s.
         # @option arguments [Boolean] :preserve_existing If +true+, existing index settings remain unchanged.
+        # @option arguments [Boolean] :reopen Whether to close and reopen the index to apply non-dynamic settings.
+        #  If set to +true+ the indices to which the settings are being applied
+        #  will be closed temporarily and then reopened in order to apply the changes.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the
         #   timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb
@@ -45,7 +45,7 @@ module Actions
         # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
         #  matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
         #  'order' values are merged later, overriding templates with lower values.
-        # @option arguments [String] :cause [TODO]
+        # @option arguments [String] :cause User defined reason for creating/updating the index template
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb
@@ -38,6 +38,7 @@ module Actions
         # @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)
         # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+        # @option arguments [String] :resource Changed resource to reload analyzers from if applicable
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb
@@ -60,6 +60,8 @@ module Actions
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
         #  Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
+        # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.
+        #  Only allowed on data streams.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb
@@ -26,6 +26,8 @@ module Actions
         # Get the index configuration that would be applied to the specified index from an existing index template.
         #
         # @option arguments [String] :name Name of the index to simulate (*Required*)
+        # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
+        # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
         # @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] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb
@@ -28,6 +28,7 @@ module Actions
         # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit
         #  this parameter and specify the template configuration in the request body.
         # @option arguments [Boolean] :create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
+        # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
         # @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] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb
@@ -27,7 +27,7 @@ module Actions
         # @option arguments [String] :inference_id The inference Id (*Required*)
         # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body request body
+        # @option arguments [Hash] :body chat_completion_request
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference
         #
@@ -39,6 +39,7 @@ def chat_completion_unified(arguments = {})
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id]
 
           arguments = arguments.clone
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb
@@ -48,6 +48,7 @@ module Actions
       #  Typically, this adds a small overhead to a request.
       #  However, using computationally expensive named queries on a large number of hits may add significant overhead.
       # @option arguments [Integer] :max_concurrent_searches Maximum number of concurrent searches the multi search API can execute.
+      #  Defaults to +max(1, (# of data nodes * min(search thread pool size, 10)))+.
       # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5.
       # @option arguments [Integer] :pre_filter_shard_size Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
       # @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb
@@ -60,6 +60,7 @@ module Actions
       # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
       #  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.
+      # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb
@@ -101,7 +101,7 @@ module Actions
       #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
       #  It supports comma-separated values, such as +open,hidden+.
       #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
-      # @option arguments [Integer] :from Starting offset (default: 0)
+      # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0.
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
       # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
       #  This parameter can be used only when the +q+ query string parameter is specified.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb
@@ -25,7 +25,10 @@ module Actions
         # Update Watcher index settings.
         # Update settings for the Watcher internal index (+.watches+).
         # Only a subset of settings can be modified.
-        # This includes +index.auto_expand_replicas+ and +index.number_of_replicas+.
+        # This includes +index.auto_expand_replicas+, +index.number_of_replicas+, +index.routing.allocation.exclude.*+,
+        # +index.routing.allocation.include.*+ and +index.routing.allocation.require.*+.
+        # Modification of +index.routing.allocation.include._tier_preference+ is an exception and is not allowed as the
+        # Watcher shards must always be in the +data_content+ tier.
         #
         # @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.
diff --git a/elasticsearch-api/spec/unit/actions/inference/chat_completion_unified_spec.rb b/elasticsearch-api/spec/unit/actions/inference/chat_completion_unified_spec.rb
@@ -23,14 +23,14 @@
       'POST',
       '_inference/chat_completion/bar/_stream',
       {},
-      nil,
+      {},
       {},
       { defined_params: { inference_id: 'bar' },
         endpoint: 'inference.chat_completion_unified' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.chat_completion_unified(inference_id: 'bar')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.chat_completion_unified(inference_id: 'bar', body: {})).to be_a Elasticsearch::API::Response
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ module Actions`
`26`	`26`	`# Asynchronously run an ES\|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.`
`27`	`27`	`# The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.`
`28`	`28`	`#`
	`29`	`+ # @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.`
`29`	`30`	`# @option arguments [String] :delimiter The character to use between values within a CSV row.`
`30`	`31`	`# It is valid only for the CSV format.`
`31`	`32`	`# @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ module Actions`
`32`	`32`	`# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.`
`33`	`33`	`# @option arguments [Boolean] :drop_null_columns Should columns that are entirely +null+ be removed from the +columns+ and +values+ portion of the results?`
`34`	`34`	`# Defaults to +false+. If +true+ then the response will include an extra section under the name +all_columns+ which has the name of all columns.`
	`35`	`+ # @option arguments [Boolean] :allow_partial_results If +true+, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.`
`35`	`36`	`# @option arguments [Hash] :headers Custom HTTP headers`
`36`	`37`	`# @option arguments [Hash] :body request body`
`37`	`38`	`#`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ module Actions`
`26`	`26`	`# Check whether index templates exist.`
`27`	`27`	`#`
`28`	`28`	`# @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard () expressions are supported. (Required*)`
	`29`	`+ # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.`
	`30`	`+ # @option arguments [Boolean] :flat_settings If true, returns settings in flat format.`
`29`	`31`	`# @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.`
`30`	`32`	`# @option arguments [Hash] :headers Custom HTTP headers`
`31`	`33`	`#`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,6 @@ module Actions`
`42`	`42`	`# Supports comma-separated values, such as +open,hidden+.`
`43`	`43`	`# @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.`
`44`	`44`	`# @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.`
`45`		`- # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.`
`46`		`- # Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.`
`47`	`45`	`# @option arguments [Hash] :headers Custom HTTP headers`
`48`	`46`	`#`
`49`	`47`	`# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ module Actions`
`45`	`45`	`# @option arguments [Integer] :order Order in which Elasticsearch applies this template if index`
`46`	`46`	`# matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher`
`47`	`47`	`# 'order' values are merged later, overriding templates with lower values.`
`48`		`- # @option arguments [String] :cause [TODO]`
	`48`	`+ # @option arguments [String] :cause User defined reason for creating/updating the index template`
`49`	`49`	`# @option arguments [Hash] :headers Custom HTTP headers`
`50`	`50`	`# @option arguments [Hash] :body request body`
`51`	`51`	`#`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ module Actions`
`38`	`38`	`# @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)`
`39`	`39`	`# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.`
`40`	`40`	`# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)`
	`41`	`+ # @option arguments [String] :resource Changed resource to reload analyzers from if applicable`
`41`	`42`	`# @option arguments [Hash] :headers Custom HTTP headers`
`42`	`43`	`#`
`43`	`44`	`# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,8 @@ module Actions`
`60`	`60`	`# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.`
`61`	`61`	`# @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.`
`62`	`62`	`# Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.`
	`63`	`+ # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.`
	`64`	`+ # Only allowed on data streams.`
`63`	`65`	`# @option arguments [Hash] :headers Custom HTTP headers`
`64`	`66`	`# @option arguments [Hash] :body request body`
`65`	`67`	`#`