elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/{fleet/post_secret.rb → indices/migrate_reindex.rb}

@@ -15,36 +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 Fleet
+    module Indices
       module Actions
-        # Creates a secret stored by Fleet.
+        # Reindex legacy backing indices.
+        # Reindex all legacy backing indices for a data stream.
+        # This operation occurs in a persistent task.
+        # The persistent task ID is returned immediately and the reindexing work is completed in that task.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The secret value to store (*Required*)
+        # @option arguments [Hash] :body reindex
         #
-        # @see [TODO]
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-reindex
         #
-        def post_secret(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || 'fleet.post_secret' }
+        def migrate_reindex(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_reindex' }
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = '_fleet/secret'
+          path   = '_migration/reindex'
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,21 +15,31 @@
 # 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
-        # Migrates an alias to a data stream
+        # Convert an index alias to a data stream.
+        # Converts an index alias to a data stream.
+        # You must have a matching index template that is data stream enabled.
+        # The alias must meet the following criteria:
+        # The alias must have a write index;
+        # All indices for the alias must have a +@timestamp+ field mapping of a +date+ or +date_nanos+ field type;
+        # The alias must not have any filters;
+        # The alias must not use custom routing.
+        # If successful, the request removes the alias and creates a data stream with the same name.
+        # The indices for the alias become hidden backing indices for the stream.
+        # The write index for the alias becomes the write index for the stream.
         #
-        # @option arguments [String] :name The name of the alias to migrate
-        # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String] :name Name of the index alias to convert to a data stream. (*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/data-streams.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream
         #
         def migrate_to_data_stream(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' }
@@ -49,7 +59,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_data_stream/_migrate/#{Utils.__listify(_name)}"
+          path   = "_data_stream/_migrate/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,19 +15,20 @@
 # 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
-        # Modifies a data stream
+        # Update data streams.
+        # Performs one or more data stream modification actions in a single atomic operation.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data stream modifications (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream
         #
         def modify_data_stream(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' }
@@ -37,7 +38,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_data_stream/_modify'

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

@@ -15,25 +15,52 @@
 # 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
-        # Opens an index.
+        # Open a closed index.
+        # For data streams, the API opens any closed backing indices.
+        # A closed index is blocked for read/write operations and does not allow all operations that opened indices allow.
+        # It is not possible to index documents or to search for documents in a closed index.
+        # This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.
+        # When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.
+        # The shards will then go through the normal recovery process.
+        # The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.
+        # You can open and close multiple indices.
+        # An error is thrown if the request explicitly refers to a missing index.
+        # This behavior can be turned off by using the +ignore_unavailable=true+ parameter.
+        # By default, you must explicitly name the indices you are opening or closing.
+        # To open or close indices with +_all+, +*+, or other wildcard expressions, change the +action.destructive_requires_name+ setting to +false+.
+        # This setting can also be changed with the cluster update settings API.
+        # Closed indices consume a significant amount of disk-space which can cause problems in managed environments.
+        # Closing indices can be turned off with the cluster settings API by setting +cluster.indices.close.enable+ to +false+.
+        # Because opening or closing an index allocates its shards, the +wait_for_active_shards+ setting on index creation applies to the +_open+ and +_close+ index actions as well.
         #
-        # @option arguments [List] :index A comma separated list of indices to open
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @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] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  By default, you must explicitly name the indices you using to limit the request.
+        #  To limit a request using +_all+, +*+, or other wildcard expressions, change the +action.destructive_requires_name+ setting to false.
+        #  You can update this setting in the +elasticsearch.yml+ file or using the cluster update settings API. (*Required*)
+        # @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 [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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-open-close.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-open
         #
         def open(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.open' }
@@ -48,12 +75,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)}/_open"
+          path   = "#{Utils.listify(_index)}/_open"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,28 @@
 # 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
-        # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
+        # Promote a data stream.
+        # Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.
+        # With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.
+        # These data streams can't be rolled over in the local cluster.
+        # These replicated data streams roll over only if the upstream data stream rolls over.
+        # In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.
+        # NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.
+        # If this is missing, the data stream will not be able to roll over until a matching index template is created.
+        # This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.
         #
-        # @option arguments [String] :name The name of the data stream
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String] :name The name of the data stream (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-promote-data-stream
         #
         def promote_data_stream(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.promote_data_stream' }
@@ -48,7 +56,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_data_stream/_promote/#{Utils.__listify(_name)}"
+          path   = "_data_stream/_promote/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,28 +15,35 @@
 # 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
-        # Creates or updates an alias.
+        # Create or update an alias.
+        # Adds a data stream or index to an alias.
         #
-        # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
-        # @option arguments [String] :name The name of the alias to be created or updated
-        # @option arguments [Time] :timeout Explicit timestamp for the document
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String, Array] :index Comma-separated list of data streams or indices to add.
+        #  Supports wildcards (+*+).
+        #  Wildcard patterns that match both data streams and indices return an error. (*Required*)
+        # @option arguments [String] :name Alias to update.
+        #  If the alias doesn’t exist, the request creates it.
+        #  Index alias names support date math. (*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 settings for the alias, such as `routing` or `filter`
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias
         #
         def put_alias(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_alias' }
 
-          defined_params = %i[index name].each_with_object({}) do |variable, set_variables|
+          defined_params = [:index, :name].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?
@@ -47,14 +54,14 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           _index = arguments.delete(:index)
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = ("#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}" if _index && _name)
+          path   = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name)
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,23 +15,31 @@
 # 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
-        # Updates the data stream lifecycle of the selected data streams.
+        # Update data stream lifecycles.
+        # Update the data stream lifecycle of the specified data streams.
         #
-        # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams
-        # @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 [Time] :timeout Explicit timestamp for the document
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String, Array<String>] :name Comma-separated list of data streams used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams use +*+ or +_all+. (*Required*)
+        # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
+        #  Supports comma-separated values, such as +open,hidden+.
+        #  Valid values are: +all+, +hidden+, +open+, +closed+, +none+. Server default: open.
+        # @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 data stream lifecycle configuration that consist of the data retention
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-put-lifecycle.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-data-lifecycle
         #
         def put_data_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_lifecycle' }
@@ -51,7 +59,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_data_stream/#{Utils.__listify(_name)}/_lifecycle"
+          path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,23 +15,44 @@
 # 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
-        # Creates or updates an 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 wildcard pattern that matches the index name.
+        # Index templates are applied during data stream or index creation.
+        # For data streams, these settings and mappings are applied when the stream's backing indices are created.
+        # Settings and mappings specified in a create index API request override any settings or mappings specified in an index template.
+        # Changes to index templates do not affect existing indices, including the existing backing indices of a data stream.
+        # 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.
+        # **Multiple matching templates**
+        # If multiple index templates match the name of a new index or data stream, the template with the highest priority is used.
+        # Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.
+        # **Composing aliases, mappings, and settings**
+        # When multiple component templates are specified in the +composed_of+ field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.
+        # Any mappings, settings, or aliases from the parent index template are merged in next.
+        # Finally, any configuration on the index request itself is merged.
+        # Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.
+        # If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.
+        # This recursive merging strategy applies not only to field mappings, but also root options like +dynamic_templates+ and +meta+.
+        # If an earlier component contains a +dynamic_templates+ block, then by default new +dynamic_templates+ entries are appended onto the end.
+        # If an entry already exists with the same key, then it is overwritten by the new definition.
         #
-        # @option arguments [String] :name The name of the template
-        # @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 Index or template name (*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 [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.17/indices-put-template.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template
         #
         def put_index_template(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_index_template' }
@@ -52,7 +73,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_index_template/#{Utils.__listify(_name)}"
+          path   = "_index_template/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,26 +15,51 @@
 # 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
-        # Updates the index mappings.
+        # Update field mappings.
+        # Add new fields to an existing data stream or index.
+        # You can also use this API to change the search settings of existing fields and add new properties to existing object fields.
+        # For data streams, these changes are applied to all backing indices by default.
+        # **Add multi-fields to an existing field**
+        # Multi-fields let you index the same field in different ways.
+        # You can use this API to update the fields mapping parameter and enable multi-fields for an existing field.
+        # WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.
+        # You can populate the new multi-field with the update by query API.
+        # **Change supported mapping parameters for an existing field**
+        # The documentation for each mapping parameter indicates whether you can update it for an existing field using this API.
+        # For example, you can use the update mapping API to update the +ignore_above+ parameter.
+        # **Change the mapping of an existing field**
+        # Except for supported mapping parameters, you can't change the mapping or field type of an existing field.
+        # Changing an existing field could invalidate data that's already indexed.
+        # If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.
+        # If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.
+        # **Rename a field**
+        # Renaming a field would invalidate data already indexed under the old field name.
+        # Instead, add an alias field to create an alternate field name.
         #
-        # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @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] :write_index_only When true, applies mappings only to the write index of an alias or data stream
+        # @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use +_all+ or omit to add the mapping on all indices. (*Required*)
+        # @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 [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 [Boolean] :write_index_only If +true+, the mappings are applied only to the current write index for the target.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The mapping definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-mapping.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping
         #
         def put_mapping(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_mapping' }
@@ -50,12 +75,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_PUT
-          path   = "#{Utils.__listify(_index)}/_mapping"
+          path   = "#{Utils.listify(_index)}/_mapping"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(