[API] Updates API to specification commit 119eb27ee25a0be53121ed59edadbc5acb55462e

picandocodigo · picandocodigo · commit 9302d5a8f135 · 2025-07-17T12:57:06.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.
* 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")
* search - Adds [Boolean] `:ccs_minimize_roundtrips` Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true.
* reindex - adds :max_docs parameter, the maximum number of documents to reindex
* search_mvt - adds :track_total_hits the number of hits matching the query to count accurately
* security.grant_api_key - adds :refresh, if 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
* snapshot.delete - adds :wait_for_completion, if `true`, the request returns a response when the matching snapshots are all deleted.
diff --git 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<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>] :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<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 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
@@ -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<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>] :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<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 [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
@@ -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/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<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :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<String>] :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
@@ -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/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<String>] :expand_wildcards [TODO] Server default: open.
+        # @option arguments [String, Array<String>] :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
@@ -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/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/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
@@ -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
@@ -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<String>] :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
@@ -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<String>] :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
@@ -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<String>] :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
@@ -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
diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb
