elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/index.rb

@@ -15,37 +15,138 @@
 # 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 Actions
-      # Creates or updates a document in an index.
+      # Create or update a document in an index.
+      # Add a JSON document to the specified data stream or index and make it searchable.
+      # If the target is an index and the document already exists, the request updates the document and increments its version.
+      # NOTE: You cannot use this API to send update requests for existing documents in a data stream.
+      # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
+      # * To add or overwrite a document using the +PUT /<target>/_doc/<_id>+ request format, you must have the +create+, +index+, or +write+ index privilege.
+      # * To add a document using the +POST /<target>/_doc/+ request format, you must have the +create_doc+, +create+, +index+, or +write+ index privilege.
+      # * To automatically create a data stream or index with this API request, you must have the +auto_configure+, +create_index+, or +manage+ index privilege.
+      # Automatic data stream creation requires a matching index template with data stream enabled.
+      # NOTE: Replica shards might not all be started when an indexing operation returns successfully.
+      # By default, only the primary is required. Set +wait_for_active_shards+ to change this default behavior.
+      # **Automatically create data streams and indices**
+      # If the request's target doesn't exist and matches an index template with a +data_stream+ definition, the index operation automatically creates the data stream.
+      # If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.
+      # NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.
+      # If no mapping exists, the index operation creates a dynamic mapping.
+      # By default, new fields and objects are automatically added to the mapping if needed.
+      # Automatic index creation is controlled by the +action.auto_create_index+ setting.
+      # If it is +true+, any index can be created automatically.
+      # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to +false+ to turn off automatic index creation entirely.
+      # Specify a comma-separated list of patterns you want to allow or prefix each pattern with +++ or +-+ to indicate whether it should be allowed or blocked.
+      # When a list is specified, the default behaviour is to disallow.
+      # NOTE: The +action.auto_create_index+ setting affects the automatic creation of indices only.
+      # It does not affect the creation of data streams.
+      # **Optimistic concurrency control**
+      # Index operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the +if_seq_no+ and +if_primary_term+ parameters.
+      # If a mismatch is detected, the operation will result in a +VersionConflictException+ and a status code of +409+.
+      # **Routing**
+      # By default, shard placement — or routing — is controlled by using a hash of the document's ID value.
+      # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the +routing+ parameter.
+      # When setting up explicit mapping, you can also use the +_routing+ field to direct the index operation to extract the routing value from the document itself.
+      # This does come at the (very minimal) cost of an additional document parsing pass.
+      # If the +_routing+ mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.
+      # NOTE: Data streams do not support custom routing unless they were created with the +allow_custom_routing+ setting enabled in the template.
+      # **Distributed**
+      # The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.
+      # After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.
+      # **Active shards**
+      # To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.
+      # If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.
+      # By default, write operations only wait for the primary shards to be active before proceeding (that is to say +wait_for_active_shards+ is +1+).
+      # This default can be overridden in the index settings dynamically by setting +index.write.wait_for_active_shards+.
+      # To alter this behavior per operation, use the +wait_for_active_shards request+ parameter.
+      # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is +number_of_replicas++1).
+      # Specifying a negative value or a number greater than the number of shard copies will throw an error.
+      # For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).
+      # If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.
+      # This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.
+      # If +wait_for_active_shards+ is set on the request to +3+ (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.
+      # This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.
+      # However, if you set +wait_for_active_shards+ to +all+ (or to +4+, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.
+      # The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.
+      # It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.
+      # After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.
+      # The +_shards+ section of the API response reveals the number of shard copies on which replication succeeded and failed.
+      # **No operation (noop) updates**
+      # When updating a document by using this API, a new version of the document is always created even if the document hasn't changed.
+      # If this isn't acceptable use the +_update+ API with +detect_noop+ set to +true+.
+      # The +detect_noop+ option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.
+      # There isn't a definitive rule for when noop updates aren't acceptable.
+      # It's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.
+      # **Versioning**
+      # Each indexed document is given a version number.
+      # By default, internal versioning is used that starts at 1 and increments with each update, deletes included.
+      # Optionally, the version number can be set to an external value (for example, if maintained in a database).
+      # To enable this functionality, +version_type+ should be set to +external+.
+      # The value provided must be a numeric, long value greater than or equal to 0, and less than around +9.2e+18+.
+      # NOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.
+      # If no version is provided, the operation runs without any version checks.
+      # When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.
+      # If true, the document will be indexed and the new version number used.
+      # If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:
+      # ```
+      # PUT my-index-000001/_doc/1?version=2&version_type=external
+      # {
+      #   "user": {
+      #     "id": "elkbee"
+      #   }
+      # }
+      # In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
+      # If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
+      # A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.
+      # Even the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.
       #
-      # @option arguments [String] :id Document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)
-      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
-      # @option arguments [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
-      # @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
-      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
-      # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
-      # @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false
+      # @option arguments [String] :id A unique identifier for the document.
+      #  To automatically generate a document ID, use the +POST /<target>/_doc/+ request format and omit this parameter.
+      # @option arguments [String] :index The name of the data stream or index to target.
+      #  If the target doesn't exist and matches the name or wildcard (+*+) pattern of an index template with a +data_stream+ definition, this request creates the data stream.
+      #  If the target doesn't exist and doesn't match a data stream template, this request creates the index.
+      #  You can check for existing targets with the resolve index API. (*Required*)
+      # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+      # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+      # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
+      # @option arguments [String] :op_type Set to +create+ to only index the document if it does not already exist (put if absent).
+      #  If a document with the specified +_id+ already exists, the indexing operation will fail.
+      #  The behavior is the same as using the +<index>/_create+ endpoint.
+      #  If a document ID is specified, this paramater defaults to +index+.
+      #  Otherwise, it defaults to +create+.
+      #  If the request targets a data stream, an +op_type+ of +create+ is required.
+      # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
+      #  If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request.
+      #  If a final pipeline is configured it will always run, regardless of the value of this parameter.
+      # @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+, it does nothing with refreshes. Server default: false.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.
+      #  Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.
+      #  By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.
+      #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
+      # @option arguments [Integer] :version An explicit version number for concurrency control.
+      #  It must be a non-negative long number.
+      # @option arguments [String] :version_type The version type.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
+      #  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 [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The document (*Required*)
+      # @option arguments [Hash] :body document
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create
       #
       def index(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'index' }
 
-        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+        defined_params = [:index, :id].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?
@@ -64,9 +165,9 @@ module Elasticsearch
 
         method = _id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST
         path   = if _index && _id
-                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+                   "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}"
                  else
-                   "#{Utils.__listify(_index)}/_doc"
+                   "#{Utils.listify(_index)}/_doc"
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb

@@ -15,21 +15,22 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.
+        # Delete a lifecycle policy.
+        # You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
         #
-        # @option arguments [String] :policy The name of the index lifecycle policy
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy Identifier for the policy. (*Required*)
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-delete-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-delete-lifecycle
         #
         def delete_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.delete_lifecycle' }
@@ -49,7 +50,7 @@ module Elasticsearch
           _policy = arguments.delete(:policy)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ilm/policy/#{Utils.__listify(_policy)}"
+          path   = "_ilm/policy/#{Utils.listify(_policy)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb

@@ -15,22 +15,26 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
+        # Explain the lifecycle state.
+        # Get the current lifecycle status for one or more indices.
+        # For data streams, the API retrieves the current lifecycle status for the stream's backing indices.
+        # The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.
         #
-        # @option arguments [String] :index The name of the index to explain
-        # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
-        # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :index Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (+*+).
+        #  To target all data streams and indices, use +*+ or +_all+. (*Required*)
+        # @option arguments [Boolean] :only_errors Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.
+        # @option arguments [Boolean] :only_managed Filters the returned indices to only indices that are managed by ILM.
+        # @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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-explain-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-explain-lifecycle
         #
         def explain_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.explain_lifecycle' }
@@ -45,12 +49,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)}/_ilm/explain"
+          path   = "#{Utils.listify(_index)}/_ilm/explain"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb

@@ -15,21 +15,21 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Returns the specified policy definition. Includes the policy version and last modified date.
+        # Get lifecycle policies.
         #
-        # @option arguments [String] :policy The name of the index lifecycle policy
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy Identifier for the policy.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-get-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-get-lifecycle
         #
         def get_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_lifecycle' }
@@ -48,7 +48,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _policy
-                     "_ilm/policy/#{Utils.__listify(_policy)}"
+                     "_ilm/policy/#{Utils.listify(_policy)}"
                    else
                      '_ilm/policy'
                    end

data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb

@@ -15,18 +15,19 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Retrieves the current index lifecycle management (ILM) status.
+        # Get the ILM status.
+        # Get the current index lifecycle management status.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-get-status.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-get-status
         #
         def get_status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_status' }
@@ -34,7 +35,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_ilm/status'

data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb

@@ -15,20 +15,34 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
+        # Migrate to data tiers routing.
+        # Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.
+        # Optionally, delete one legacy index template.
+        # Using node roles enables ILM to automatically move the indices between data tiers.
+        # Migrating away from custom node attributes routing can be manually performed.
+        # This API provides an automated way of performing three out of the four manual steps listed in the migration guide:
+        # 1. Stop setting the custom hot attribute on new indices.
+        # 1. Remove custom allocation settings from existing ILM policies.
+        # 1. Replace custom allocation settings from existing indices with the corresponding tier preference.
+        # ILM must be stopped before performing the migration.
+        # Use the stop ILM and get ILM status APIs to wait until the reported operation mode is +STOPPED+.
         #
-        # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false
+        # @option arguments [Boolean] :dry_run If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.
+        #  This provides a way to retrieve the indices and ILM policies that need to be migrated.
+        # @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.
+        #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data")
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-migrate-to-data-tiers.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-migrate-to-data-tiers
         #
         def migrate_to_data_tiers(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.migrate_to_data_tiers' }
@@ -36,7 +50,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_ilm/migrate_to_data_tiers'

data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb

@@ -15,20 +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 IndexLifecycleManagement
       module Actions
-        # Manually moves an index into the specified step and executes that step.
+        # Move to a lifecycle step.
+        # Manually move an index into a specific step in the lifecycle policy and run that step.
+        # WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.
+        # You must specify both the current step and the step to be executed in the body of the request.
+        # The request will fail if the current step does not match the step currently running for the index
+        # This is to prevent the index from being moved from an unexpected step into the next step.
+        # When specifying the target (+next_step+) to which the index will be moved, either the name or both the action and name fields are optional.
+        # If only the phase is specified, the index will move to the first step of the first action in the target phase.
+        # If the phase and action are specified, the index will move to the first step of the specified action in the specified phase.
+        # Only actions specified in the ILM policy are considered valid.
+        # An index cannot move to a step that is not part of its policy.
         #
-        # @option arguments [String] :index The name of the index whose lifecycle step is to change
+        # @option arguments [String] :index The name of the index whose lifecycle step is to change (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The new lifecycle step to move to
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-move-to-step.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-move-to-step
         #
         def move_to_step(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.move_to_step' }
@@ -43,12 +53,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ilm/move/#{Utils.__listify(_index)}"
+          path   = "_ilm/move/#{Utils.listify(_index)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb

@@ -15,22 +15,24 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Creates a lifecycle policy
+        # Create or update a lifecycle policy.
+        # If the specified policy exists, it is replaced and the policy version is incremented.
+        # NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.
         #
-        # @option arguments [String] :policy The name of the index lifecycle policy
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy Identifier for the policy. (*Required*)
+        # @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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The lifecycle policy definition to register
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-put-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-put-lifecycle
         #
         def put_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.put_lifecycle' }
@@ -50,7 +52,7 @@ module Elasticsearch
           _policy = arguments.delete(:policy)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_ilm/policy/#{Utils.__listify(_policy)}"
+          path   = "_ilm/policy/#{Utils.listify(_policy)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb

@@ -15,19 +15,21 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Removes the assigned lifecycle policy and stops managing the specified index
+        # Remove policies from an index.
+        # Remove the assigned lifecycle policies from an index or a data stream's backing indices.
+        # It also stops managing the indices.
         #
-        # @option arguments [String] :index The name of the index to remove policy on
+        # @option arguments [String] :index The name of the index to remove policy on (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-remove-policy.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-remove-policy
         #
         def remove_policy(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.remove_policy' }
@@ -42,12 +44,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "#{Utils.__listify(_index)}/_ilm/remove"
+          path   = "#{Utils.listify(_index)}/_ilm/remove"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb

@@ -15,19 +15,22 @@
 # 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 IndexLifecycleManagement
       module Actions
-        # Retries executing the policy for an index that is in the ERROR step.
+        # Retry a policy.
+        # Retry running the lifecycle policy for an index that is in the ERROR step.
+        # The API sets the policy back to the step where the error occurred and runs the step.
+        # Use the explain lifecycle state API to determine whether an index is in the ERROR step.
         #
-        # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry
+        # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-retry-policy.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-retry
         #
         def retry(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ilm.retry' }
@@ -42,12 +45,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "#{Utils.__listify(_index)}/_ilm/retry"
+          path   = "#{Utils.listify(_index)}/_ilm/retry"
           params = {}
 
           Elasticsearch::API::Response.new(