elasticsearch-api 9.2.0 → 9.2.1

data/lib/elasticsearch/api/actions/inference/put_mistral.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[:mistral_inference_id]
             raise ArgumentError,
                   "Required argument 'mistral_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_openai.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[:openai_inference_id]
             raise ArgumentError,
                   "Required argument 'openai_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_voyageai.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[:voyageai_inference_id]
             raise ArgumentError,
                   "Required argument 'voyageai_inference_id' missing"

data/lib/elasticsearch/api/actions/inference/put_watsonx.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[:watsonx_inference_id]
             raise ArgumentError,
                   "Required argument 'watsonx_inference_id' missing"

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform reranking inference on the service
+        # Perform reranking inference on the service.
         #
         # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*)
         # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s.

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform sparse embedding inference on the service
+        # Perform sparse embedding inference on the 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/stream_completion.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform streaming inference.
+        # Perform streaming inference on the service.
         # Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.
         # 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.

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform text embedding inference on the service
+        # Perform text embedding inference on the 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/ingest/get_pipeline.rb

@@ -31,7 +31,7 @@ module Elasticsearch
         #  To get all ingest pipelines, omit this parameter or use `*`.
         # @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] :summary Return pipelines without their definitions (default: false)
+        # @option arguments [Boolean] :summary Return pipelines without their definitions
         # @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/license/post_start_basic.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # You must then re-submit the API request with the `acknowledge` parameter set to `true`.
         # To check the status of your basic license, use the get basic license API.
         #
-        # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
+        # @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. 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

data/lib/elasticsearch/api/actions/license/post_start_trial.rb

@@ -28,8 +28,8 @@ module Elasticsearch
         # For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.
         # To check the status of your trial, use the get trial status API.
         #
-        # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
-        # @option arguments [String] :type The type of trial license to generate (default: "trial")
+        # @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
+        # @option arguments [String] :type The type of trial license to generate Server default: trial.
         # @option arguments [Time] :master_timeout 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.

data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb

@@ -52,6 +52,7 @@ module Elasticsearch
         # @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
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics
         #
@@ -68,7 +69,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _id = arguments.delete(:id)
 

data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb

@@ -37,7 +37,7 @@ module Elasticsearch
         #  If this setting is greater than the number of hardware threads
         #  it will automatically be changed to a value less than the number of hardware threads.
         #  If adaptive_allocations is enabled, do not set this value, because it’s automatically set. Server default: 1.
-        # @option arguments [String] :priority The deployment priority.
+        # @option arguments [String] :priority The deployment priority
         # @option arguments [Integer] :queue_capacity Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
         #  this value, new requests are rejected with a 429 error. Server default: 1024.
         # @option arguments [Integer] :threads_per_allocation Sets the number of threads used by each model allocation during inference. This generally increases

data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb

@@ -53,6 +53,7 @@ module Elasticsearch
         # @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
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics
         #
@@ -69,7 +70,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _id = arguments.delete(:id)
 

data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb

@@ -43,6 +43,7 @@ module Elasticsearch
         # @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
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment
         #
@@ -59,7 +60,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _model_id = arguments.delete(:model_id)
 

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

@@ -23,9 +23,12 @@ module Elasticsearch
     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

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

@@ -44,7 +44,7 @@ module Elasticsearch
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search.
       # @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.
       # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions 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_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
       # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
       # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes

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

@@ -24,10 +24,9 @@ module Elasticsearch
       module Actions
         # Clear the archived repositories metering.
         # Clear the archived repositories metering information in the cluster.
-        # 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] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
         # @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*)
@@ -55,7 +54,6 @@ module Elasticsearch
           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"

data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb

@@ -26,10 +26,9 @@ module Elasticsearch
         # Get repositories metering information for a cluster.
         # This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.
         # Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.
-        # 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] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/nodes/hot_threads.rb

@@ -35,7 +35,7 @@ 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 [String] :type The type to sample. Server default: cpu.
-        # @option arguments [String] :sort The sort order for 'cpu' type (default: total)
+        # @option arguments [String] :sort The sort order for 'cpu' type Server default: total.
         # @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/nodes/stats.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # By default, all stats are returned. You can limit the returned information by using metrics.
         #
         # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information.
-        # @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
+        # @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics.
         # @option arguments [String, Array<String>] :index_metric Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
         # @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>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

data/lib/elasticsearch/api/actions/nodes/usage.rb

@@ -24,7 +24,8 @@ module Elasticsearch
       module Actions
         # Get feature usage information.
         #
-        # @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information.
+        #  Use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
         # @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics.
         #  A comma-separated list of the following options: `_all`, `rest_actions`.
         # @option arguments [Time] :timeout Period to wait for a response.

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

@@ -22,11 +22,14 @@ module Elasticsearch
   module API
     module Project
       module Actions
-        # Return tags defined for the project
-        # 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.
+        # 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.
         #
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.
@@ -41,7 +44,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-project-tags
         #
         def tags(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'project.tags' }

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

@@ -28,7 +28,7 @@ module Elasticsearch
       #  Wildcard (`*`) expressions are supported.
       #  To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.
       # @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 [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      # @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 If `true`, missing or closed indices are not included in the response.
       # @option arguments [String] :search_type Search operation type
       # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -35,7 +35,7 @@ module Elasticsearch
       #
       # @option arguments [String] :task_id The task identifier, which can be found by using the tasks API. (*Required*)
       # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
-      #  It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.
+      #  It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. (*Required*)
       # @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/scripts_painless_execute.rb

@@ -27,10 +27,9 @@ module Elasticsearch
       # This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.
       # The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.
       # Each context requires a script, but additional parameters depend on the context you're using for that script.
-      # 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
       #  when they occur.

data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb

@@ -24,10 +24,9 @@ module Elasticsearch
       module Actions
         # Delete a behavioral analytics collection.
         # The associated data stream is also deleted.
-        # 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] :name The name of the analytics collection to be deleted (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb

@@ -23,10 +23,9 @@ module Elasticsearch
     module SearchApplication
       module Actions
         # Get behavioral analytics collections.
-        # 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 [Array<String>] :name A list of analytics collections to limit the returned information
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb

@@ -23,10 +23,9 @@ module Elasticsearch
     module SearchApplication
       module Actions
         # Create a behavioral analytics collection event.
-        # 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] :collection_name The name of the behavioral analytics collection. (*Required*)
         # @option arguments [String] :event_type The analytics event type. (*Required*)

data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb

@@ -23,10 +23,9 @@ module Elasticsearch
     module SearchApplication
       module Actions
         # Create a behavioral analytics collection.
-        # 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] :name The name of the analytics collection to be created or updated. (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/search_application/render_query.rb

@@ -27,10 +27,9 @@ module Elasticsearch
         # If a parameter used in the search template is not specified in `params`, the parameter's default value will be used.
         # The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.
         # You must have `read` privileges on the backing alias of the search application.
-        # 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] :name The name of the search application to render teh query for. (*Required*)
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -96,11 +96,18 @@ module Elasticsearch
       # Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
       # Learn how to use the vector tile search API with practical examples in the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search Vector tile search examples} guide.
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*)
-      # @option arguments [String] :field Field containing geospatial data to return (*Required*)
-      # @option arguments [Integer] :zoom Zoom level for the vector tile to search (*Required*)
-      # @option arguments [Integer] :x X coordinate for the vector tile to search (*Required*)
-      # @option arguments [Integer] :y Y coordinate for the vector tile to search (*Required*)
+      # @option arguments [String, Array] :index A list of indices, data streams, or aliases to search.
+      #  It supports wildcards (`*`).
+      #  To search all data streams and indices, omit this parameter or use `*` or `_all`.
+      #  To search a remote cluster, use the `<cluster>:<target>` syntax. (*Required*)
+      # @option arguments [String] :field A field that contains the geospatial data to return.
+      #  It must be a `geo_point` or `geo_shape` field.
+      #  The field must have doc values enabled. It cannot be a nested field.NOTE: Vector tiles do not natively support geometry collections.
+      #  For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.
+      #  This behavior may change in a future release. (*Required*)
+      # @option arguments [Integer] :zoom The zoom level of the vector tile to search. It accepts `0` to `29`. (*Required*)
+      # @option arguments [Integer] :x The X coordinate for the vector tile to search. (*Required*)
+      # @option arguments [Integer] :y The Y coordinate for the vector tile to search. (*Required*)
       # @option arguments [Boolean] :exact_bounds If `false`, the meta layer's feature is the bounding box of the tile.
       #  If true, the meta layer's feature is a bounding box resulting from a
       #  geo_bounds aggregation. The aggregation runs on <field> values that intersect

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

@@ -28,10 +28,10 @@ module Elasticsearch
       # @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`.
+      #  Supports comma-separated values, such as `open,hidden`. Server default: open.
       # @option arguments [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit.
       # @option arguments [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true.
       # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.

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

@@ -24,13 +24,11 @@ module Elasticsearch
       module Actions
         # Get cache statistics.
         # Get statistics about the shared cache for partially mounted indices.
-        # 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] :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

data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb

@@ -24,15 +24,15 @@ module Elasticsearch
       module Actions
         # Clear the cache.
         # Clear indices and data streams from the shared cache for partially mounted indices.
-        # 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 A comma-separated list of data streams, indices, and aliases to clear from the cache.
         #  It supports wildcards (`*`).
-        # @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] :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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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/security/create_service_token.rb

@@ -33,7 +33,7 @@ module Elasticsearch
         #  If omitted, a random name will be generated.Token names must be at least one and no more than 256 characters.
         #  They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account.
         #  They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
-        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
+        # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
         # @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/security/delete_service_token.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
         # @option arguments [String] :service The service name. (*Required*)
         # @option arguments [String] :name The name of the service account token. (*Required*)
-        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
+        # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
         # @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/simulate/ingest.rb

@@ -35,10 +35,9 @@ module Elasticsearch
         # By default, the pipeline definitions that are currently in the system are used.
         # However, you can supply substitute pipeline definitions in the body of the request.
         # These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.
-        # 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 The index to simulate ingesting into.
         #  This value can be overridden by specifying an index on each document.

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

@@ -49,7 +49,7 @@ module Elasticsearch
         #  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.

data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb

@@ -48,10 +48,9 @@ module Elasticsearch
         # For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.
         # The response exposes implementation details of the analysis which may change from version to version.
         # The response body format is therefore not considered stable and may be different in newer versions.
-        # 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<String>] :repository The name of the snapshot repository. (*Required*)
         # @option arguments [Integer] :blob_thread_pool_concurrency If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once. Server default: 1.

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb

@@ -25,7 +25,7 @@ module Elasticsearch
         # Get policy information.
         # Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.
         #
-        # @option arguments [String, Array<String>] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
+        # @option arguments [String, Array<String>] :policy_id A comma-separated list of snapshot lifecycle policy identifiers.
         # @option arguments [Time] :master_timeout The 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 The period to wait for a response.