elasticsearch-api 9.0.2 → 9.0.4

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

@@ -27,25 +27,36 @@ module Elasticsearch
         # For data streams, it returns setting information for the stream's backing indices.
         #
         # @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+.
+        #  the request. Supports wildcards (`*`). To target all data streams and
+        #  indices, omit this parameter or use `*` or `_all`.
         # @option arguments [String, Array<String>] :name Comma-separated list or wildcard expression of settings to retrieve.
-        # @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
+        # @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.
+        #  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 [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+. Server default: open.
-        # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-        # @option arguments [Boolean] :include_defaults If +true+, return all default settings in the response.
-        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only. If
-        #  +false+, information is retrieved from the master node.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open.
+        # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
+        # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response.
+        # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. If
+        #  `false`, information is retrieved from the master node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
         #  received before the timeout expires, the request fails and returns an
         #  error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings

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

@@ -22,17 +22,28 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Get index templates.
+        # Get legacy index templates.
         # Get information about one or more index templates.
         # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
         #
         # @option arguments [String, Array<String>] :name Comma-separated list of index template names used to limit the request.
-        #  Wildcard (+*+) expressions are supported.
-        #  To return all index templates, omit this parameter or use a value of +_all+ or +*+.
-        # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
-        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
+        #  Wildcard (`*`) expressions are supported.
+        #  To return all index templates, omit this parameter or use a value of `_all` or `*`.
+        # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-template

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

@@ -31,6 +31,17 @@ module Elasticsearch
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body reindex
         #
@@ -48,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_migration/reindex'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -27,7 +27,7 @@ module Elasticsearch
         # 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;
+        # 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.
@@ -37,6 +37,17 @@ module Elasticsearch
         # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream

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

@@ -25,6 +25,17 @@ module Elasticsearch
         # Update data streams.
         # Performs one or more data stream modification actions in a single atomic operation.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -42,7 +53,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_data_stream/_modify'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -32,32 +32,42 @@ module Elasticsearch
         # 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.
+        # 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+.
+        # 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.
+        # 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 [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
-        #  Supports wildcards (+*+).
+        #  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.
+        #  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.
+        #  Supports comma-separated values, such as `open,hidden`. 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.
+        #  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] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-open

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

@@ -34,6 +34,17 @@ module Elasticsearch
         #
         # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-promote-data-stream

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # Adds a data stream or index to an alias.
         #
         # @option arguments [String, Array] :index Comma-separated list of data streams or indices to add.
-        #  Supports wildcards (+*+).
+        #  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.
@@ -35,6 +35,17 @@ module Elasticsearch
         #  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] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -26,16 +26,26 @@ module Elasticsearch
         # Update the data stream lifecycle of the specified data streams.
         #
         # @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*)
+        #  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.
+        #  Supports comma-separated values, such as `open,hidden`. 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -29,26 +29,37 @@ module Elasticsearch
         # 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 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.
+        # 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.
+        # 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 Index or template name (*Required*)
-        # @option arguments [Boolean] :create If +true+, this request cannot replace or update existing index templates.
+        # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -24,38 +24,39 @@ module Elasticsearch
       module Actions
         # 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.
+        # You can use the update mapping API to:
+        # - Add a new field to an existing index
+        # - Update mappings for multiple indices in a single request
+        # - Add new properties to an object field
+        # - Enable multi-fields for an existing field
+        # - Update supported mapping parameters
+        # - Change a field's mapping using reindexing
+        # - Rename a field using a field alias
+        # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
         #
-        # @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.
+        # @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.
+        #  Supports comma-separated values, such as `open,hidden`. 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 [Boolean] :write_index_only If `true`, the mappings are applied only to the current write index for the target.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -26,8 +26,48 @@ module Elasticsearch
         # Changes dynamic index settings in real time.
         # For data streams, index setting changes are applied to all backing indices by default.
         # To revert a setting to the default value, use a null value.
-        # The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
-        # To preserve existing settings from being updated, set the +preserve_existing+ parameter to +true+.
+        # The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
+        # To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.
+        # For performance optimization during bulk indexing, you can disable the refresh interval.
+        # Refer to {https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval disable refresh interval} for an example.
+        # There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
+        #
+        # ```
+        # {
+        #   "number_of_replicas": 1
+        # }
+        # ```
+        #
+        # Or you can use an `index` setting object:
+        #
+        # ```
+        # {
+        #   "index": {
+        #     "number_of_replicas": 1
+        #   }
+        # }
+        # ```
+        #
+        # Or you can use dot annotation:
+        #
+        # ```
+        # {
+        #   "index.number_of_replicas": 1
+        # }
+        # ```
+        #
+        # Or you can embed any of the aforementioned options in a `settings` object. For example:
+        #
+        # ```
+        # {
+        #   "settings": {
+        #     "index": {
+        #       "number_of_replicas": 1
+        #     }
+        #   }
+        # }
+        # ```
+        #
         # NOTE: You can only define new analyzers on closed indices.
         # To add an analyzer, you must close the index, define the analyzer, and reopen the index.
         # You cannot close the write index of a data stream.
@@ -36,30 +76,42 @@ module Elasticsearch
         # This affects searches and any new data added to the stream after the rollover.
         # However, it does not affect the data stream's backing indices or their existing data.
         # To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.
+        # Refer to {https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices updating analyzers on existing indices} for step-by-step examples.
         #
         # @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
+        #  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. For
-        #  example, a request targeting +foo*,bar*+ returns an error if an index
-        #  starts with +foo+ but no index starts with +bar+.
+        #  example, a request targeting `foo*,bar*` returns an error if an index
+        #  starts with `foo` but no index starts with `bar`.
         # @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+. Server default: open.
-        # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
-        # @option arguments [Boolean] :ignore_unavailable If +true+, returns settings in flat format.
+        #  `open,hidden`. Server default: open.
+        # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @option arguments [Boolean] :ignore_unavailable If `true`, returns settings in flat format.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
         #  received before the timeout expires, the request fails and returns an
         #  error. Server default: 30s.
-        # @option arguments [Boolean] :preserve_existing If +true+, existing index settings remain unchanged.
+        # @option arguments [Boolean] :preserve_existing If `true`, existing index settings remain unchanged.
         # @option arguments [Boolean] :reopen Whether to close and reopen the index to apply non-dynamic settings.
-        #  If set to +true+ the indices to which the settings are being applied
+        #  If set to `true` the indices to which the settings are being applied
         #  will be closed temporarily and then reopened in order to apply the changes.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the
         #   timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body settings
         #

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Create or update an index template.
+        # Create or update a legacy 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.
@@ -31,7 +31,7 @@ module Elasticsearch
         # 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 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.
@@ -46,6 +46,17 @@ module Elasticsearch
         #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -41,10 +41,27 @@ module Elasticsearch
         # 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 [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.
+        #  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 [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`. 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] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery