elasticsearch-api 9.2.0 → 9.2.1

data/lib/elasticsearch/api/actions/fleet/search.rb

@@ -25,10 +25,9 @@ module Elasticsearch
         # Run a Fleet search.
         # The purpose of the Fleet search API is to provide an API where the search will be run only
         # after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
         # @option arguments [Boolean] :allow_no_indices [TODO]

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

@@ -93,6 +93,7 @@ module Elasticsearch
       # When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.
       # If true, the document will be indexed and the new version number used.
       # If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:
+      #
       # ```
       # PUT my-index-000001/_doc/1?version=2&version_type=external
       # {
@@ -100,6 +101,8 @@ module Elasticsearch
       #     "id": "elkbee"
       #   }
       # }
+      # ```
+      #
       # In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
       # If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
       # A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.

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

@@ -24,10 +24,6 @@ module Elasticsearch
       module Actions
         # Cancel a migration reindex operation.
         # Cancel a migration reindex attempt for a data stream or index.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String, Array] :index The index or data stream name (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -24,10 +24,6 @@ module Elasticsearch
       module Actions
         # Create an index from a source index.
         # Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :source The source index or data stream name (*Required*)
         # @option arguments [String] :dest The destination index or data stream name (*Required*)

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

@@ -29,7 +29,7 @@ module Elasticsearch
         #  Wildcard expressions (`*`) are supported.
         #  To target all data streams in a cluster, omit this parameter or use `*`.
         # @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
-        #  Supports comma-separated values, such as `open,hidden`. Server default: open.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
         # @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

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

@@ -37,7 +37,7 @@ module Elasticsearch
         #  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.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
         # @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.

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

@@ -25,10 +25,11 @@ module Elasticsearch
         # Delete data stream lifecycles.
         # Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.
         #
-        # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*)
-        # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
-        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted.
+        #  Use `*` to get all data streams (*Required*)
+        # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response. 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

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

@@ -25,10 +25,11 @@ module Elasticsearch
         # Delete data stream options.
         # Removes the data stream options from a data stream.
         #
-        # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*)
-        # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
-        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted.
+        #  Use `*` to get all data streams (*Required*)
+        # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices Server default: open.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [Time] :timeout The period to wait for a response. 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

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

@@ -30,10 +30,9 @@ module Elasticsearch
         # Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.
         # The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.
         # For usage examples see the External documentation or refer to {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage Analyze the index disk usage example} for an example.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
         #  It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*)

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

@@ -29,10 +29,9 @@ module Elasticsearch
         # NOTE: Only indices in a time series data stream are supported.
         # Neither field nor document level security can be defined on the source index.
         # The source index must be read only (`index.blocks.write: true`).
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String] :index Name of the time series index to downsample. (*Required*)
         # @option arguments [String] :target_index Name of the index to create. (*Required*)

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

@@ -32,7 +32,7 @@ module Elasticsearch
         #  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.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: all.
         # @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
         # @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.

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

@@ -25,9 +25,9 @@ module Elasticsearch
         # Get the status for a data stream lifecycle.
         # Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
         #
-        # @option arguments [String, Array] :index The name of the index to explain (*Required*)
-        # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
+        # @option arguments [String, Array] :index Comma-separated list of index names to explain (*Required*)
+        # @option arguments [Boolean] :include_defaults Indicates if the API should return the default values the system uses for the index's lifecycle
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. 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

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

@@ -28,10 +28,9 @@ module Elasticsearch
         # A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
         # The response body reports the per-shard usage count of the data structures that back the fields in the index.
         # A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*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.
@@ -39,7 +38,7 @@ module Elasticsearch
         #  For 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`.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
         # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -64,13 +64,14 @@ module Elasticsearch
         # ```
         #
         # @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 [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] :flush Specify whether the index should be flushed after performing the operation (default: true)
+        # @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. Server default: open.
+        # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation Server default: true.
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
         # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
-        # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. Server default: true.
+        # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed 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

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

@@ -35,7 +35,7 @@ module Elasticsearch
         #  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.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: all.
         # @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.

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # Get index templates.
         # Get information about one or more index templates.
         #
-        # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.
+        # @option arguments [String] :name Name of index template to retrieve. Wildcard (*) expressions are supported.
         # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
         # @option arguments [Boolean] :flat_settings 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.

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

@@ -24,10 +24,6 @@ module Elasticsearch
       module Actions
         # Get the migration reindexing status.
         # Get the status of a migration reindex attempt for a data stream or index.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String, Array] :index The index or data stream name. (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -26,10 +26,6 @@ module Elasticsearch
         # Reindex all legacy backing indices for a data stream.
         # This operation occurs in a persistent task.
         # The persistent task ID is returned immediately and the reindexing work is completed in that task.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

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

@@ -49,7 +49,7 @@ module Elasticsearch
         #  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.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: closed.
         # @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.

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # If this is missing, the data stream will not be able to roll over until a matching index template is created.
         # This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.
         #
-        # @option arguments [String] :name The name of the data stream (*Required*)
+        # @option arguments [String] :name The name of the data stream to promote (*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.

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

@@ -48,7 +48,7 @@ module Elasticsearch
         # @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 Server default: api.
+        # @option arguments [String] :cause User defined reason for creating or updating the index template Server default: api.
         # @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

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

@@ -34,7 +34,8 @@ module Elasticsearch
         # - 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 [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.

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

@@ -45,7 +45,7 @@ module Elasticsearch
         # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
         #  matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
         #  'order' values are merged later, overriding templates with lower values.
-        # @option arguments [String] :cause User defined reason for creating/updating the index template Server default: .
+        # @option arguments [String] :cause User defined reason for creating or updating the index template Server default: "".
         # @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

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

@@ -35,8 +35,9 @@ 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 [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        # @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. Server default: open.
         # @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

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

@@ -34,6 +34,7 @@ module Elasticsearch
         # For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.
         # If the number of shards in the index is a prime number it can only be shrunk into a single primary shard
         #  Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.
+        # IMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.
         # The current write index on a data stream cannot be shrunk. In order to shrink 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 shrunk.
         # A shrink operation:
         # * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.

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

@@ -31,12 +31,12 @@ module Elasticsearch
         # 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<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<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`. Server default: open.
         # @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.

data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform chat completion inference
+        # Perform chat completion inference on the service.
         # 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.
+        # It only works with the `chat_completion` task type.
         # 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`, `hugging_face` or the `elastic` service, use the Chat completion inference API.
+        # To determine whether a given inference service supports this task type, please see the page for that service.
         #
         # @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.

data/lib/elasticsearch/api/actions/inference/completion.rb

@@ -22,7 +22,11 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform completion inference on the service
+        # Perform completion inference on the service.
+        # Get responses for completion tasks.
+        # This API works only with the completion task type.
+        # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
+        # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege).
         #
         # @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.

data/lib/elasticsearch/api/actions/inference/delete.rb

@@ -22,11 +22,12 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Delete an inference endpoint
+        # Delete an inference endpoint.
+        # This API requires the manage_inference cluster privilege (the built-in `inference_admin` role grants this privilege).
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference identifier. (*Required*)
-        # @option arguments [Boolean] :dry_run When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.
+        # @option arguments [Boolean] :dry_run When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.
         # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/inference/get.rb

@@ -22,10 +22,12 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Get an inference endpoint
+        # Get an inference endpoint.
+        # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege).
         #
-        # @option arguments [String] :task_type The task type
-        # @option arguments [String] :inference_id The inference Id
+        # @option arguments [String] :task_type The task type of the endpoint to return
+        # @option arguments [String] :inference_id The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified
+        #  `task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified
         # @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
@@ -61,6 +63,8 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_GET
           path   = if _task_type && _inference_id
                      "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   elsif _task_type
+                     "_inference/#{Utils.listify(_task_type)}/_all"
                    elsif _inference_id
                      "_inference/#{Utils.listify(_inference_id)}"
                    else

data/lib/elasticsearch/api/actions/inference/put.rb

@@ -46,7 +46,7 @@ module Elasticsearch
         # * Mistral (`chat_completion`, `completion`, `text_embedding`)
         # * OpenAI (`chat_completion`, `completion`, `text_embedding`)
         # * VoyageAI (`rerank`, `text_embedding`)
-        # * Watsonx inference integration (`text_embedding`)
+        # * Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)
         #
         # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:alibabacloud_inference_id]
             raise ArgumentError,
                   "Required argument 'alibabacloud_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:amazonbedrock_inference_id]
             raise ArgumentError,
                   "Required argument 'amazonbedrock_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:amazonsagemaker_inference_id]
             raise ArgumentError,
                   "Required argument 'amazonsagemaker_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_anthropic.rb

@@ -55,7 +55,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:anthropic_inference_id]
             raise ArgumentError,
                   "Required argument 'anthropic_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:azureaistudio_inference_id]
             raise ArgumentError,
                   "Required argument 'azureaistudio_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb

@@ -59,7 +59,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:azureopenai_inference_id]
             raise ArgumentError,
                   "Required argument 'azureopenai_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_cohere.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:cohere_inference_id]
             raise ArgumentError,
                   "Required argument 'cohere_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_contextualai.rb

@@ -55,7 +55,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:contextualai_inference_id]
             raise ArgumentError,
                   "Required argument 'contextualai_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_custom.rb

@@ -84,7 +84,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:custom_inference_id]
             raise ArgumentError,
                   "Required argument 'custom_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_deepseek.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:deepseek_inference_id]
             raise ArgumentError,
                   "Required argument 'deepseek_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb

@@ -55,7 +55,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:elasticsearch_inference_id]
             raise ArgumentError,
                   "Required argument 'elasticsearch_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:googleaistudio_inference_id]
             raise ArgumentError,
                   "Required argument 'googleaistudio_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb

@@ -54,7 +54,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:googlevertexai_inference_id]
             raise ArgumentError,
                   "Required argument 'googlevertexai_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb

@@ -82,7 +82,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:huggingface_inference_id]
             raise ArgumentError,
                   "Required argument 'huggingface_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_jinaai.rb

@@ -56,7 +56,6 @@ module Elasticsearch
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:jinaai_inference_id]
             raise ArgumentError,
                   "Required argument 'jinaai_inference_id' missing"