elasticsearch-api 8.19.2 → 9.0.0

data/lib/elasticsearch/api/actions/indices/put_template.rb

@@ -15,24 +15,41 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Create or update a legacy index template
+        # Create or update an index template.
+        # Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
+        # Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
+        # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
+        # Composable templates always take precedence over legacy templates.
+        # If no composable template matches a new index, matching legacy templates are applied according to their order.
+        # Index templates are only applied during index creation.
+        # Changes to index templates do not affect existing indices.
+        # Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.
+        # You can use C-style +/* *\/+ block comments in index templates.
+        # You can include comments anywhere in the request body, except before the opening curly bracket.
+        # **Indices matching multiple templates**
+        # Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.
+        # The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.
+        # NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.
         #
-        # @option arguments [String] :name The name of the template
-        # @option arguments [Integer] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
-        # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
+        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [Boolean] :create If true, this request cannot replace or update existing index templates.
+        # @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 [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 User defined reason for creating/updating the index template
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The template definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-template
         #
         def put_template(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_template' }
@@ -53,7 +70,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_template/#{Utils.__listify(_name)}"
+          path   = "_template/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/indices/recovery.rb

@@ -15,24 +15,39 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Get index recovery information
+        # Get index recovery information.
+        # Get information about ongoing and completed shard recoveries for one or more indices.
+        # For data streams, the API returns information for the stream's backing indices.
+        # All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.
+        # Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.
+        # When a shard recovery completes, the recovered shard is available for search and indexing.
+        # Recovery automatically occurs during the following processes:
+        # * When creating an index for the first time.
+        # * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.
+        # * Creation of new replica shard copies from the primary.
+        # * Relocation of a shard copy to a different node in the same cluster.
+        # * A snapshot restore operation.
+        # * A clone, shrink, or split operation.
+        # You can determine the cause of a shard recovery using the recovery or cat recovery APIs.
+        # The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.
+        # It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.
+        # This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery
-        # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-recovery.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery
         #
         def recovery(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.recovery' }
@@ -45,13 +60,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _index
-                     "#{Utils.__listify(_index)}/_recovery"
+                     "#{Utils.listify(_index)}/_recovery"
                    else
                      '_recovery'
                    end

data/lib/elasticsearch/api/actions/indices/refresh.rb

@@ -15,22 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Refresh an index
+        # Refresh an index.
+        # A refresh makes recent operations performed on one or more indices available for search.
+        # For data streams, the API runs the refresh operation on the stream’s backing indices.
+        # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
+        # You can change this default interval with the +index.refresh_interval+ setting.
+        # Refresh requests are synchronous and do not return a response until the refresh operation completes.
+        # Refreshes are resource-intensive.
+        # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.
+        # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's +refresh=wait_for+ query parameter option.
+        # This option ensures the indexing operation waits for a periodic refresh before running the search.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @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<String>] :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+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. 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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh
         #
         def refresh(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.refresh' }
@@ -43,13 +58,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "#{Utils.__listify(_index)}/_refresh"
+                     "#{Utils.listify(_index)}/_refresh"
                    else
                      '_refresh'
                    end

data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb

@@ -15,23 +15,33 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Reload search analyzers
+        # Reload search analyzers.
+        # Reload an index's search analyzers and their resources.
+        # For data streams, the API reloads search analyzers and resources for the stream's backing indices.
+        # IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.
+        # You can use the reload search analyzers API to pick up changes to synonym files used in the +synonym_graph+ or +synonym+ token filter of a search analyzer.
+        # To be eligible, the token filter must have an +updateable+ flag of +true+ and only be used in search analyzers.
+        # NOTE: This API does not perform a reload for each shard of an index.
+        # Instead, it performs a reload for each node containing index shards.
+        # As a result, the total shard count returned by the API can differ from the number of index shards.
+        # Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.
+        # This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.
         #
-        # @option arguments [List] :index A comma-separated list of index names to reload analyzers for
+        # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*)
+        # @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 [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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [String] :resource changed resource to reload analyzers from if applicable
+        # @option arguments [String] :resource Changed resource to reload analyzers from if applicable
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers
         #
         def reload_search_analyzers(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.reload_search_analyzers' }
@@ -46,12 +56,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "#{Utils.__listify(_index)}/_reload_search_analyzers"
+          path   = "#{Utils.listify(_index)}/_reload_search_analyzers"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb

@@ -15,24 +15,72 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Resolve the cluster
+        # Resolve the cluster.
+        # Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included.
+        # If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.
+        # This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.
+        # You use the same index expression with this endpoint as you would for cross-cluster search.
+        # Index and cluster exclusions are also supported with this endpoint.
+        # For each cluster in the index expression, information is returned about:
+        # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the +remote/info+ endpoint.
+        # * Whether each remote cluster is configured with +skip_unavailable+ as +true+ or +false+.
+        # * Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
+        # * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
+        # * Cluster version information, including the Elasticsearch server version.
+        # For example, +GET /_resolve/cluster/my-index-*,cluster*:my-index-*+ returns information about the local cluster and all remotely configured clusters that start with the alias +cluster*+.
+        # Each cluster returns information about whether it has any indices, aliases or data streams that match +my-index-*+.The ability to query without an index expression was added in version 8.18, so when
+        # querying remote clusters older than that, the local cluster will send the index
+        # expression +dummy*+ to those remote clusters. Thus, if an errors occur, you may see a reference
+        # to that index expression even though you didn't request it. If it causes a problem, you can
+        # instead include an index expression like +*:*+ to bypass the issue.You may want to exclude a cluster or index from a search when:
+        # * A remote cluster is not currently connected and is configured with +skip_unavailable=false+. Running a cross-cluster search under those conditions will cause the entire search to fail.
+        # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is +logs*,remote1:logs*+ and the remote1 cluster has no indices, aliases or data streams that match +logs*+. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
+        # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the +_resolve/cluster+ response will be present. (This is also where security/permission errors will be shown.)
+        # * A remote cluster is an older version that does not support the feature you want to use in your search.The +remote/info+ endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
+        # The remote cluster may be available, while the local cluster is not currently connected to it.
+        # You can use the +_resolve/cluster+ API to attempt to reconnect to remote clusters.
+        # For example with +GET _resolve/cluster+ or +GET _resolve/cluster/*:*+.
+        # The +connected+ field in the response will indicate whether it was successful.
+        # If a connection was (re-)established, this will also cause the +remote/info+ endpoint to now indicate a connected status.
         #
-        # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression.
-        # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression.
-        # @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). Only allowed when providing an index expression.
-        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. (options: open, closed, hidden, none, all)
-        # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond
+        # @option arguments [String, Array<String>] :name A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.
+        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax.
+        #  Index and cluster exclusions (e.g., +-cluster1:*+) are also supported.
+        #  If no index expression is specified, information about all remote clusters configured on the local cluster
+        #  is returned without doing any index matching
+        # @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. For example, a request
+        #  targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+.
+        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
+        #  options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: true.
+        # @option arguments [String, Array<String>] :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+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
+        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
+        #  options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: open.
+        # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen.
+        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
+        #  options to the +_resolve/cluster+ API endpoint that takes no index expression.
+        # @option arguments [Boolean] :ignore_unavailable If false, the request returns an error if it targets a missing or closed index.
+        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
+        #  options to the +_resolve/cluster+ API endpoint that takes no index expression.
+        # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond.
+        #  If a remote cluster does not respond within this timeout period, the API response
+        #  will show the cluster as not connected and include an error message that the
+        #  request timed out.The default timeout is unset and the query can take
+        #  as long as the networking layer is configured to wait for remote clusters that are
+        #  not responding (typically 30 seconds).
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster
         #
         def resolve_cluster(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' }
@@ -51,7 +99,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _name
-                     "_resolve/cluster/#{Utils.__listify(_name)}"
+                     "_resolve/cluster/#{Utils.listify(_name)}"
                    else
                      '_resolve/cluster'
                    end

data/lib/elasticsearch/api/actions/indices/resolve_index.rb

@@ -15,22 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Resolve indices
+        # Resolve indices.
+        # Resolve the names and/or index patterns for indices, aliases, and data streams.
+        # Multiple patterns and remote clusters are supported.
         #
-        # @option arguments [List] :name A comma-separated list of names or wildcard expressions
-        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @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>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
+        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
+        # @option arguments [String, Array<String>] :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+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. 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] :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.
+        #  For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index
         #
         def resolve_index(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' }
@@ -50,7 +58,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_resolve/index/#{Utils.__listify(_name)}"
+          path   = "_resolve/index/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/indices/rollover.rb

@@ -15,31 +15,62 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Roll over to a new index
+        # Roll over to a new index.
+        # TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.
+        # The rollover API creates a new index for a data stream or index alias.
+        # The API behavior depends on the rollover target.
+        # **Roll over a data stream**
+        # If you roll over a data stream, the API creates a new write index for the stream.
+        # The stream's previous write index becomes a regular backing index.
+        # A rollover also increments the data stream's generation.
+        # **Roll over an index alias with a write index**
+        # TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.
+        # Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.
+        # If an index alias points to multiple indices, one of the indices must be a write index.
+        # The rollover API creates a new write index for the alias with +is_write_index+ set to +true+.
+        # The API also +sets is_write_index+ to +false+ for the previous write index.
+        # **Roll over an index alias with one index**
+        # If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.
+        # NOTE: A rollover creates a new index and is subject to the +wait_for_active_shards+ setting.
+        # **Increment index names for an alias**
+        # When you roll over an index alias, you can specify a name for the new index.
+        # If you don't specify a name and the current index ends with +-+ and a number, such as +my-index-000001+ or +my-index-3+, the new index name increments that number.
+        # For example, if you roll over an alias with a current index of +my-index-000001+, the rollover creates a new index named +my-index-000002+.
+        # This number is always six characters and zero-padded, regardless of the previous index's name.
+        # If you use an index alias for time series data, you can use date math in the index name to track the rollover date.
+        # For example, you can create an alias that points to an index named +<my-index-{now/d}-000001>+.
+        # If you create the index on May 6, 2099, the index's name is +my-index-2099.05.06-000001+.
+        # If you roll over the alias on May 7, 2099, the new index's name is +my-index-2099.05.07-000002+.
         #
-        # @option arguments [String] :alias The name of the alias to rollover
-        # @option arguments [String] :new_index The name of the rollover index
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
-        # @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 [String] :alias Name of the data stream or index alias to roll over. (*Required*)
+        # @option arguments [String] :new_index Name of the index to create.
+        #  Supports date math.
+        #  Data streams do not support this parameter.
+        # @option arguments [Boolean] :dry_run If +true+, checks whether the current index satisfies the specified conditions but does not perform a rollover.
+        # @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 [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 [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 The conditions that needs to be met for executing rollover
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover
         #
         def rollover(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' }
 
-          defined_params = %i[alias new_index].each_with_object({}) do |variable, set_variables|
+          defined_params = [:alias, :new_index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -49,7 +80,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           _alias = arguments.delete(:alias)
 
@@ -57,9 +88,9 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _alias && _new_index
-                     "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}"
+                     "#{Utils.listify(_alias)}/_rollover/#{Utils.listify(_new_index)}"
                    else
-                     "#{Utils.__listify(_alias)}/_rollover"
+                     "#{Utils.listify(_alias)}/_rollover"
                    end
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/indices/segments.rb

@@ -15,23 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Get index segments
+        # Get index segments.
+        # Get low-level information about the Lucene segments in index shards.
+        # For data streams, the API returns information about the stream's backing indices.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene. *Deprecated*
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @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<String>] :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+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. 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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-segments.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments
         #
         def segments(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' }
@@ -44,13 +51,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _index
-                     "#{Utils.__listify(_index)}/_segments"
+                     "#{Utils.listify(_index)}/_segments"
                    else
                      '_segments'
                    end