elasticsearch-api 9.0.3 → 9.0.4

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

@@ -26,23 +26,33 @@ module Elasticsearch
         # A refresh makes recent operations performed on one or more indices available for search.
         # For data streams, the API runs the refresh operation on the stream’s backing indices.
         # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
-        # You can change this default interval with the +index.refresh_interval+ setting.
+        # You can change this default interval with the `index.refresh_interval` setting.
         # Refresh requests are synchronous and do not return a response until the refresh operation completes.
         # Refreshes are resource-intensive.
         # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.
-        # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's +refresh=wait_for+ query parameter option.
+        # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.
         # This option ensures the indexing operation waits for a periodic refresh before running the search.
         #
         # @option arguments [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.
+        #  Supports wildcards (`*`).
+        #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
         #  This behavior applies even if the request targets other open indices. Server default: true.
         # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
         #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-        #  Supports comma-separated values, such as +open,hidden+.
-        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+        #  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-refresh

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

@@ -26,8 +26,8 @@ module Elasticsearch
         # Reload an index's search analyzers and their resources.
         # For data streams, the API reloads search analyzers and resources for the stream's backing indices.
         # IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.
-        # You can use the reload search analyzers API to pick up changes to synonym files used in the +synonym_graph+ or +synonym+ token filter of a search analyzer.
-        # To be eligible, the token filter must have an +updateable+ flag of +true+ and only be used in search analyzers.
+        # You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.
+        # To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.
         # NOTE: This API does not perform a reload for each shard of an index.
         # Instead, it performs a reload for each node containing index shards.
         # As a result, the total shard count returned by the API can differ from the number of index shards.
@@ -35,10 +35,21 @@ module Elasticsearch
         # This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.
         #
         # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [String] :resource Changed resource to reload analyzers from if applicable
+        # @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-reload-search-analyzers

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

@@ -29,55 +29,65 @@ module Elasticsearch
         # You use the same index expression with this endpoint as you would for cross-cluster search.
         # Index and cluster exclusions are also supported with this endpoint.
         # For each cluster in the index expression, information is returned about:
-        # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the +remote/info+ endpoint.
-        # * Whether each remote cluster is configured with +skip_unavailable+ as +true+ or +false+.
+        # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.
+        # * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.
         # * Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
         # * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
         # * Cluster version information, including the Elasticsearch server version.
-        # For example, +GET /_resolve/cluster/my-index-*,cluster*:my-index-*+ returns information about the local cluster and all remotely configured clusters that start with the alias +cluster*+.
-        # Each cluster returns information about whether it has any indices, aliases or data streams that match +my-index-*+.The ability to query without an index expression was added in version 8.18, so when
+        # For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.
+        # Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.The ability to query without an index expression was added in version 8.18, so when
         # querying remote clusters older than that, the local cluster will send the index
-        # expression +dummy*+ to those remote clusters. Thus, if an errors occur, you may see a reference
+        # expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference
         # to that index expression even though you didn't request it. If it causes a problem, you can
-        # instead include an index expression like +*:*+ to bypass the issue.You may want to exclude a cluster or index from a search when:
-        # * A remote cluster is not currently connected and is configured with +skip_unavailable=false+. Running a cross-cluster search under those conditions will cause the entire search to fail.
-        # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is +logs*,remote1:logs*+ and the remote1 cluster has no indices, aliases or data streams that match +logs*+. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
-        # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the +_resolve/cluster+ response will be present. (This is also where security/permission errors will be shown.)
-        # * A remote cluster is an older version that does not support the feature you want to use in your search.The +remote/info+ endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
+        # instead include an index expression like `*:*` to bypass the issue.You may want to exclude a cluster or index from a search when:
+        # * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.
+        # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
+        # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)
+        # * A remote cluster is an older version that does not support the feature you want to use in your search.The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
         # The remote cluster may be available, while the local cluster is not currently connected to it.
-        # You can use the +_resolve/cluster+ API to attempt to reconnect to remote clusters.
-        # For example with +GET _resolve/cluster+ or +GET _resolve/cluster/*:*+.
-        # The +connected+ field in the response will indicate whether it was successful.
-        # If a connection was (re-)established, this will also cause the +remote/info+ endpoint to now indicate a connected status.
+        # You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.
+        # For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.
+        # The `connected` field in the response will indicate whether it was successful.
+        # If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.
         #
         # @option arguments [String, Array<String>] :name A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.
-        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax.
-        #  Index and cluster exclusions (e.g., +-cluster1:*+) are also supported.
+        #  Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.
+        #  Index and cluster exclusions (e.g., `-cluster1:*`) are also supported.
         #  If no index expression is specified, information about all remote clusters configured on the local cluster
         #  is returned without doing any index matching
-        # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing
+        # @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+.
+        #  targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
         #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
-        #  options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: true.
+        #  options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: true.
         # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
         #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-        #  Supports comma-separated values, such as +open,hidden+.
-        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
+        #  Supports comma-separated values, such as `open,hidden`.
         #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
-        #  options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: open.
+        #  options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open.
         # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen.
         #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
-        #  options to the +_resolve/cluster+ API endpoint that takes no index expression.
+        #  options to the `_resolve/cluster` API endpoint that takes no index expression.
         # @option arguments [Boolean] :ignore_unavailable If false, the request returns an error if it targets a missing or closed index.
         #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
-        #  options to the +_resolve/cluster+ API endpoint that takes no index expression.
+        #  options to the `_resolve/cluster` API endpoint that takes no index expression.
         # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond.
         #  If a remote cluster does not respond within this timeout period, the API response
         #  will show the cluster as not connected and include an error message that the
         #  request timed out.The default timeout is unset and the query can take
         #  as long as the networking layer is configured to wait for remote clusters that are
         #  not responding (typically 30 seconds).
+        # @option arguments [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-resolve-cluster

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

@@ -27,15 +27,25 @@ module Elasticsearch
         # Multiple patterns and remote clusters are supported.
         #
         # @option arguments [String, Array<String>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
-        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
+        #  Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax. (*Required*)
         # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
         #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-        #  Supports comma-separated values, such as +open,hidden+.
-        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+        #  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] :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.
+        #  For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
+        # @option arguments [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-resolve-index

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

@@ -34,34 +34,45 @@ module Elasticsearch
         # TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.
         # Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.
         # If an index alias points to multiple indices, one of the indices must be a write index.
-        # The rollover API creates a new write index for the alias with +is_write_index+ set to +true+.
-        # The API also +sets is_write_index+ to +false+ for the previous write index.
+        # The rollover API creates a new write index for the alias with `is_write_index` set to `true`.
+        # The API also `sets is_write_index` to `false` for the previous write index.
         # **Roll over an index alias with one index**
         # If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.
-        # NOTE: A rollover creates a new index and is subject to the +wait_for_active_shards+ setting.
+        # NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.
         # **Increment index names for an alias**
         # When you roll over an index alias, you can specify a name for the new index.
-        # If you don't specify a name and the current index ends with +-+ and a number, such as +my-index-000001+ or +my-index-3+, the new index name increments that number.
-        # For example, if you roll over an alias with a current index of +my-index-000001+, the rollover creates a new index named +my-index-000002+.
+        # If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.
+        # For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.
         # This number is always six characters and zero-padded, regardless of the previous index's name.
         # If you use an index alias for time series data, you can use date math in the index name to track the rollover date.
-        # For example, you can create an alias that points to an index named +<my-index-{now/d}-000001>+.
-        # If you create the index on May 6, 2099, the index's name is +my-index-2099.05.06-000001+.
-        # If you roll over the alias on May 7, 2099, the new index's name is +my-index-2099.05.07-000002+.
+        # For example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.
+        # If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.
+        # If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.
         #
         # @option arguments [String] :alias Name of the data stream or index alias to roll over. (*Required*)
         # @option arguments [String] :new_index Name of the index to create.
         #  Supports date math.
         #  Data streams do not support this parameter.
-        # @option arguments [Boolean] :dry_run If +true+, checks whether the current index satisfies the specified conditions but does not perform a rollover.
+        # @option arguments [Boolean] :dry_run If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Time] :timeout Period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
-        #  Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
+        #  Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
         # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.
         #  Only allowed on data streams.
+        # @option arguments [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/segments.rb

@@ -27,15 +27,25 @@ module Elasticsearch
         # For data streams, the API returns information about 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+.
-        # @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.
+        #  Supports wildcards (`*`).
+        #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
         #  This behavior applies even if the request targets other open indices. Server default: true.
         # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
         #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-        #  Supports comma-separated values, such as +open,hidden+.
-        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+        #  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-segments

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

@@ -39,7 +39,18 @@ module Elasticsearch
         # @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. Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
-        # @option arguments [Shardstorestatus] :status List of shard health statuses used to limit the request.
+        # @option arguments [String, Array<String>] :status List of shard health statuses used to limit the request.
+        # @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-shard-stores

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

@@ -38,7 +38,7 @@ module Elasticsearch
         # A shrink operation:
         # * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.
         # * Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.
-        # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the +.routing.allocation.initial_recovery._id+ index setting.
+        # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.
         # IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:
         # * The target index must not exist.
         # * The source index must have more primary shards than the target index.
@@ -53,7 +53,18 @@ module Elasticsearch
         # @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
         # @option arguments [Hash] :body request body
         #

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

@@ -30,6 +30,17 @@ module Elasticsearch
         # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
         # @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] :include_defaults If true, returns all relevant default configurations for 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
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template

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

@@ -31,6 +31,17 @@ module Elasticsearch
         # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
         # @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] :include_defaults If true, returns all relevant default configurations for 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/split.rb

@@ -28,14 +28,16 @@ module Elasticsearch
         # * The index must be read-only.
         # * The cluster health status must be green.
         # You can do make an index read-only with the following request using the add index block API:
-        # +
+        #
+        # ```
         # PUT /my_source_index/_block/write
-        # +
+        # ```
+        #
         # The current write index on a data stream cannot be split.
         # In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.
-        # The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the +index.number_of_routing_shards+ setting.
+        # The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.
         # The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.
-        # For instance, a 5 shard index with +number_of_routing_shards+ set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.
+        # For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.
         # A split operation:
         # * Creates a new target index with the same definition as the source index, but with a larger number of primary shards.
         # * Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
@@ -54,7 +56,18 @@ module Elasticsearch
         # @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
         # @option arguments [Hash] :body request body
         #

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

@@ -24,26 +24,37 @@ module Elasticsearch
       module Actions
         # Get index statistics.
         # For data streams, the API retrieves statistics for the stream's backing indices.
-        # By default, the returned statistics are index-level with +primaries+ and +total+ aggregations.
-        # +primaries+ are the values for only the primary shards.
-        # +total+ are the accumulated values for both primary and replica shards.
-        # To get shard-level statistics, set the +level+ parameter to +shards+.
+        # By default, the returned statistics are index-level with `primaries` and `total` aggregations.
+        # `primaries` are the values for only the primary shards.
+        # `total` are the accumulated values for both primary and replica shards.
+        # To get shard-level statistics, set the `level` parameter to `shards`.
         # NOTE: When moving to another node, the shard-level statistics for a shard are cleared.
         # Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.
         #
         # @option arguments [String, Array<String>] :metric Limit the information returned the specific metrics.
-        # @option arguments [String, Array] :index A comma-separated list of index names; use +_all+ or empty string to perform the operation on all indices
+        # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
         # @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+.
+        #  such as `open,hidden`.
         # @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
         # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
         # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true.
-        # @option arguments [String] :groups Comma-separated list of search groups to include in the search statistics.
+        # @option arguments [String, Array<String>] :groups Comma-separated list of search groups to include in the search statistics.
         # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
         # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
         # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
+        # @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-stats

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

@@ -29,6 +29,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/validate_query.rb

@@ -26,26 +26,36 @@ module Elasticsearch
         # Validates a query without running it.
         #
         # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
-        #  Supports wildcards (+*+).
-        #  To search all data streams or 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.
+        #  Supports wildcards (`*`).
+        #  To search all data streams or indices, omit this parameter or use `*` or `_all`.
+        # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
         #  This behavior applies even if the request targets other open indices. Server default: true.
-        # @option arguments [Boolean] :all_shards If +true+, the validation is executed on all shards instead of one random shard per index.
+        # @option arguments [Boolean] :all_shards If `true`, the validation is executed on all shards instead of one random shard per index.
         # @option arguments [String] :analyzer Analyzer to use for the query string.
-        #  This parameter can only be used when the +q+ query string parameter is specified.
-        # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
-        # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+. Server default: OR.
+        #  This parameter can only be used when the `q` query string parameter is specified.
+        # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
+        # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. Server default: OR.
         # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
-        #  This parameter can only be used when the +q+ query string parameter is specified.
+        #  This parameter can only be used when the `q` query string parameter is specified.
         # @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] :explain If +true+, the response returns detailed information if an error has occurred.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-        # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
-        # @option arguments [Boolean] :rewrite If +true+, returns a more detailed explanation showing the actual Lucene query that will be executed.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open.
+        # @option arguments [Boolean] :explain If `true`, the response returns detailed information if an error has occurred.
+        # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
+        # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
+        # @option arguments [Boolean] :rewrite If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.
         # @option arguments [String] :q Query in the Lucene query string syntax.
+        # @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/inference/chat_completion_unified.rb

@@ -23,9 +23,26 @@ module Elasticsearch
     module Inference
       module Actions
         # Perform chat completion inference
+        # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.
+        # It only works with the `chat_completion` task type for `openai` and `elastic` inference services.
+        # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.
+        # The Chat completion inference API and the Stream inference API differ in their response structure and capabilities.
+        # The Chat completion inference API provides more comprehensive customization options through more fields and function calling support.
+        # If you use the `openai` service or the `elastic` service, use the Chat completion inference API.
         #
         # @option arguments [String] :inference_id The inference Id (*Required*)
         # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. 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 chat_completion_request
         #