Updates 9.2

elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb

@@ -32,6 +32,8 @@ module Actions
         # - total store size of all shards, including shard replicas
         # These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.
         # To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
+        # NOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.
+        # IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to {https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions Elasticsearch billing dimensions}.
         # CAT APIs are only intended for human consumption using the command line or Kibana console.
         # They are not intended for use by applications. For application consumption, use an index endpoint.
         #

elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb

@@ -59,7 +59,6 @@ def sync_job_claim(arguments = {})
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
           unless arguments[:connector_sync_job_id]
             raise ArgumentError,
                   "Required argument 'connector_sync_job_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb

@@ -56,7 +56,6 @@ def sync_job_error(arguments = {})
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
           unless arguments[:connector_sync_job_id]
             raise ArgumentError,
                   "Required argument 'connector_sync_job_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb

@@ -58,7 +58,6 @@ def sync_job_update_stats(arguments = {})
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
           unless arguments[:connector_sync_job_id]
             raise ArgumentError,
                   "Required argument 'connector_sync_job_id' missing"

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

@@ -34,6 +34,7 @@ module Actions
         # 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.

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

@@ -25,8 +25,9 @@ module Actions
         # 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
@@ -62,6 +63,8 @@ def get(arguments = {})
           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

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

@@ -46,7 +46,7 @@ module Actions
         # * 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*)

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

@@ -54,7 +54,6 @@ def put_alibabacloud(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_amazonbedrock(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_amazonsagemaker(arguments = {})
 
           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"

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

@@ -55,7 +55,6 @@ def put_anthropic(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_azureaistudio(arguments = {})
 
           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"

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

@@ -59,7 +59,6 @@ def put_azureopenai(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_cohere(arguments = {})
 
           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"

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

@@ -55,7 +55,6 @@ def put_contextualai(arguments = {})
 
           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"

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

@@ -84,7 +84,6 @@ def put_custom(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_deepseek(arguments = {})
 
           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"

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

@@ -55,7 +55,6 @@ def put_elasticsearch(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_googleaistudio(arguments = {})
 
           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"

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

@@ -54,7 +54,6 @@ def put_googlevertexai(arguments = {})
 
           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"

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

@@ -82,7 +82,6 @@ def put_hugging_face(arguments = {})
 
           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"

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

@@ -56,7 +56,6 @@ def put_jinaai(arguments = {})
 
           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"

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb

@@ -54,7 +54,6 @@ def put_mistral(arguments = {})
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:mistral_inference_id]
             raise ArgumentError,
                   "Required argument 'mistral_inference_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb

@@ -55,7 +55,6 @@ def put_openai(arguments = {})
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:openai_inference_id]
             raise ArgumentError,
                   "Required argument 'openai_inference_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb

@@ -55,7 +55,6 @@ def put_voyageai(arguments = {})
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:voyageai_inference_id]
             raise ArgumentError,
                   "Required argument 'voyageai_inference_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb

@@ -56,7 +56,6 @@ def put_watsonx(arguments = {})
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
-
           unless arguments[:watsonx_inference_id]
             raise ArgumentError,
                   "Required argument 'watsonx_inference_id' missing"

elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb

@@ -23,9 +23,12 @@ module API
     module Migration
       module Actions
         # Get deprecation information.
-        # Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
-        # TIP: This APIs is designed for indirect use by the Upgrade Assistant.
-        # You are strongly recommended to use the Upgrade Assistant.
+        # Returns information about deprecated features which are in use in the cluster.
+        # The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.
+        # You must address the reported issues before upgrading to the next major version.
+        # However, no action is required when upgrading within the current major version.
+        # Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.
+        # Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.
         #
         # @option arguments [String] :index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb

@@ -54,7 +54,6 @@ def clear_repositories_metering_archive(arguments = {})
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
-
           unless arguments[:max_archive_version]
             raise ArgumentError,
                   "Required argument 'max_archive_version' missing"

elasticsearch-api/lib/elasticsearch/api/actions/project/tags.rb

@@ -24,7 +24,9 @@ module Project
       module Actions
         # Get tags.
         # Get the tags that are defined for the project.
+        #
         # This API is only available in Serverless.
+        #
         # 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.

elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb

@@ -28,7 +28,7 @@ module Actions
       # @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.
-      # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests.
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. Server default: true.
       # @option arguments [String, Array<String>] :expand_wildcards The 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.

elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb

@@ -29,7 +29,6 @@ module Actions
         # preview are not subject to the support SLA of official GA features.
         #
         # @option arguments [String, Array] :node_id The names of the nodes in the cluster to target.
-        # @option arguments [Time] :master_timeout [TODO]
         # @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

elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb

@@ -49,7 +49,7 @@ module Actions
         #  The default behavior is ascending order. Server default: asc.
         # @option arguments [Integer] :offset Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. Server default: 0.
         # @option arguments [Integer] :size The maximum number of snapshots to return.
-        #  The default is 0, which means to return all that match the request without limit. Server default: 0.
+        #  The default is -1, which means to return all that match the request without limit. Server default: -1.
         # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.You can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.
         #  For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.
         #  Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.

elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb

@@ -24,6 +24,9 @@ module Streams
       module Actions
         # Disable logs stream.
         # Turn off the logs stream feature for this cluster.
+        #
+        # This API is only available behind a feature flag: `logs_stream`.
+        #
         # 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.

elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb

@@ -27,6 +27,9 @@ module Actions
         # NOTE: To protect existing data, this feature can be turned on only if the
         # cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
         # If those indices or data streams exist, a `409 - Conflict` response and error is returned.
+        #
+        # This API is only available behind a feature flag: `logs_stream`.
+        #
         # 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.