elasticsearch-api 8.17.2 → 9.0.0

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

@@ -15,51 +15,142 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Performs an update on every document in the index without changing the source,
-      # for example to pick up a mapping change.
+      # Update documents.
+      # Updates documents that match the specified query.
+      # If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
+      # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:
+      # * +read+
+      # * +index+ or +write+
+      # You can specify the query criteria in the request URI or the request body using the same syntax as the search API.
+      # When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.
+      # When the versions match, the document is updated and the version number is incremented.
+      # If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.
+      # You can opt to count version conflicts instead of halting and returning by setting +conflicts+ to +proceed+.
+      # Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than +max_docs+ until it has successfully updated +max_docs+ documents or it has gone through every document in the source query.
+      # NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.
+      # While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.
+      # A bulk update request is performed for each batch of matching documents.
+      # Any query or update failures cause the update by query request to fail and the failures are shown in the response.
+      # Any update requests that completed successfully still stick, they are not rolled back.
+      # **Throttling update requests**
+      # To control the rate at which update by query issues batches of update operations, you can set +requests_per_second+ to any positive decimal number.
+      # This pads each batch with a wait time to throttle the rate.
+      # Set +requests_per_second+ to +-1+ to turn off throttling.
+      # Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.
+      # The padding time is the difference between the batch size divided by the +requests_per_second+ and the time spent writing.
+      # By default the batch size is 1000, so if +requests_per_second+ is set to +500+:
+      # +
+      # target_time = 1000 / 500 per second = 2 seconds
+      # wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds
+      # +
+      # Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.
+      # This is "bursty" instead of "smooth".
+      # **Slicing**
+      # Update by query supports sliced scroll to parallelize the update process.
+      # This can improve efficiency and provide a convenient way to break the request down into smaller parts.
+      # Setting +slices+ to +auto+ chooses a reasonable number for most data streams and indices.
+      # This setting will use one slice per shard, up to a certain limit.
+      # If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.
+      # Adding +slices+ to +_update_by_query+ just automates the manual process of creating sub-requests, which means it has some quirks:
+      # * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices.
+      # * Fetching the status of the task for the request with +slices+ only contains the status of completed slices.
+      # * These sub-requests are individually addressable for things like cancellation and rethrottling.
+      # * Rethrottling the request with +slices+ will rethrottle the unfinished sub-request proportionally.
+      # * Canceling the request with slices will cancel each sub-request.
+      # * Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.
+      # * Parameters like +requests_per_second+ and +max_docs+ on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using +max_docs+ with +slices+ might not result in exactly +max_docs+ documents being updated.
+      # * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.
+      # If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:
+      # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.
+      # * Update performance scales linearly across available resources with the number of slices.
+      # Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.
+      # **Update the document source**
+      # Update by query supports scripts to update the document source.
+      # As with the update API, you can set +ctx.op+ to change the operation that is performed.
+      # Set +ctx.op = "noop"+ if your script decides that it doesn't have to make any changes.
+      # The update by query operation skips updating the document and increments the +noop+ counter.
+      # Set +ctx.op = "delete"+ if your script decides that the document should be deleted.
+      # The update by query operation deletes the document and increments the +deleted+ counter.
+      # Update by query supports only +index+, +noop+, and +delete+.
+      # Setting +ctx.op+ to anything else is an error.
+      # Setting any other field in +ctx+ is an error.
+      # This API enables you to only modify the source of matching documents; you cannot move them.
       #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [String] :analyzer The analyzer to use for the query string
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
-      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
-      # @option arguments [Number] :from Starting offset (default: 0)
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @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] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
-      # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :q Query in the Lucene query string syntax
-      # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
-      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
-      # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
-      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
-      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
-      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
+      #  It supports wildcards (+*+).
+      #  To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*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.
+      #  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] :analyzer The analyzer to use for the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String] :conflicts The preferred behavior when update by query hits version conflicts: +abort+ or +proceed+. Server default: abort.
+      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
+      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @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.
+      #  It supports comma-separated values, such as +open,hidden+.
+      #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
+      # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0.
+      # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+      # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Integer] :max_docs The maximum number of documents to process.
+      #  It defaults to all documents.
+      #  When set to a value less then or equal to +scroll_size+ then a scroll will not be used to retrieve the results for the operation.
+      # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
+      #  If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request.
+      #  If a final pipeline is configured it will always run, regardless of the value of this parameter.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [String] :q A query in the Lucene query string syntax.
+      # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.
+      #  This is different than the update API's +refresh+ parameter, which causes just the shard that received the request to be refreshed.
+      # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
+      #  It defaults to the index-level setting.
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Time] :scroll The period to retain the search context for scrolling. Server default: 5m.
+      # @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000.
+      # @option arguments [Time] :search_timeout An explicit timeout for each search request.
+      #  By default, there is no timeout.
+      # @option arguments [String] :search_type The type of the search operation. Available options include +query_then_fetch+ and +dfs_query_then_fetch+.
+      # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1.
+      # @option arguments [Array<String>] :sort A comma-separated list of <field>:<direction> pairs.
+      # @option arguments [Array<String>] :stats The specific +tag+ of the request for logging and statistical purposes.
+      # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
+      #  If a query reaches this limit, Elasticsearch terminates the query early.
+      #  Elasticsearch collects documents before sorting.IMPORTANT: Use with caution.
+      #  Elasticsearch applies this parameter to each shard handling the request.
+      #  When possible, let Elasticsearch perform early termination automatically.
+      #  Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
+      # @option arguments [Time] :timeout The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.
+      #  By default, it is one minute.
+      #  This guarantees Elasticsearch waits for at least the timeout before failing.
+      #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
+      # @option arguments [Boolean] :version If +true+, returns the document version as part of a hit.
       # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
-      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
-      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
-      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
-      # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
-      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
+      #  Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
+      #  The +timeout+ parameter controls how long each write request waits for unavailable shards to become available.
+      #  Both work exactly the way they work in the bulk API. Server default: 1.
+      # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete.
+      #  If +false+, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.
+      #  Elasticsearch creates a record of this task as a document at +.tasks/task/${taskId}+. Server default: true.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The search definition using the Query DSL
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query
       #
       def update_by_query(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update_by_query' }
@@ -74,12 +165,12 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = arguments.delete(:body)
+        body = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = "#{Utils.__listify(_index)}/_update_by_query"
+        path   = "#{Utils.listify(_index)}/_update_by_query"
         params = Utils.process_params(arguments)
 
         Elasticsearch::API::Response.new(

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

@@ -15,19 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Changes the number of requests per second for a particular Update By Query operation.
+      # Throttle an update by query operation.
+      # Change the number of requests per second for a particular update by query operation.
+      # Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
       #
-      # @option arguments [String] :task_id The task id to rethrottle
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
+      # @option arguments [String] :task_id The ID for the task. (*Required*)
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
+      #  To turn off throttling, set it to +-1+. Server default: -1.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query-rethrottle
       #
       def update_by_query_rethrottle(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' }
@@ -47,7 +50,7 @@ module Elasticsearch
         _task_id = arguments.delete(:task_id)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = "_update_by_query/#{Utils.__listify(_task_id)}/_rethrottle"
+        path   = "_update_by_query/#{Utils.listify(_task_id)}/_rethrottle"
         params = Utils.process_params(arguments)
 
         Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/watcher/ack_watch.rb

@@ -15,25 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Acknowledges a watch, manually throttling the execution of the watch's actions.
+        # Acknowledge a watch.
+        # Acknowledging a watch enables you to manually throttle the execution of the watch's actions.
+        # The acknowledgement state of an action is stored in the +status.actions.<id>.ack.state+ structure.
+        # IMPORTANT: If the specified watch is currently being executed, this API will return an error
+        # The reason for this behavior is to prevent overwriting the watch status from a watch execution.
+        # Acknowledging an action throttles further executions of that action until its +ack.state+ is reset to +awaits_successful_execution+.
+        # This happens when the condition of the watch is not met (the condition evaluates to false).
         #
-        # @option arguments [String] :watch_id Watch ID
-        # @option arguments [List] :action_id A comma-separated list of the action ids to be acked
+        # @option arguments [String] :watch_id The watch identifier. (*Required*)
+        # @option arguments [String, Array<String>] :action_id A comma-separated list of the action identifiers to acknowledge.
+        #  If you omit this parameter, all of the actions of the watch are acknowledged.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-ack-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch
         #
         def ack_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' }
 
-          defined_params = %i[watch_id action_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:watch_id, :action_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,9 +58,9 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = if _watch_id && _action_id
-                     "_watcher/watch/#{Utils.__listify(_watch_id)}/_ack/#{Utils.__listify(_action_id)}"
+                     "_watcher/watch/#{Utils.listify(_watch_id)}/_ack/#{Utils.listify(_action_id)}"
                    else
-                     "_watcher/watch/#{Utils.__listify(_watch_id)}/_ack"
+                     "_watcher/watch/#{Utils.listify(_watch_id)}/_ack"
                    end
           params = {}
 

data/lib/elasticsearch/api/actions/watcher/activate_watch.rb

@@ -15,19 +15,20 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Activates a currently inactive watch.
+        # Activate a watch.
+        # A watch can be either active or inactive.
         #
-        # @option arguments [String] :watch_id Watch ID
+        # @option arguments [String] :watch_id The watch identifier. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-activate-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-activate-watch
         #
         def activate_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' }
@@ -47,7 +48,7 @@ module Elasticsearch
           _watch_id = arguments.delete(:watch_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_watcher/watch/#{Utils.__listify(_watch_id)}/_activate"
+          path   = "_watcher/watch/#{Utils.listify(_watch_id)}/_activate"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb

@@ -15,19 +15,20 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Deactivates a currently active watch.
+        # Deactivate a watch.
+        # A watch can be either active or inactive.
         #
-        # @option arguments [String] :watch_id Watch ID
+        # @option arguments [String] :watch_id The watch identifier. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-deactivate-watch
         #
         def deactivate_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.deactivate_watch' }
@@ -47,7 +48,7 @@ module Elasticsearch
           _watch_id = arguments.delete(:watch_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_watcher/watch/#{Utils.__listify(_watch_id)}/_deactivate"
+          path   = "_watcher/watch/#{Utils.listify(_watch_id)}/_deactivate"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/watcher/delete_watch.rb

@@ -15,19 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Removes a watch from Watcher.
+        # Delete a watch.
+        # When the watch is removed, the document representing the watch in the +.watches+ index is gone and it will never be run again.
+        # Deleting a watch does not delete any watch execution records related to this watch from the watch history.
+        # IMPORTANT: Deleting a watch must be done by using only this API.
+        # Do not delete the watch directly from the +.watches+ index using the Elasticsearch delete document API
+        # When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the +.watches+ index.
         #
-        # @option arguments [String] :id Watch ID
+        # @option arguments [String] :id The watch identifier. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-delete-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-delete-watch
         #
         def delete_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.delete_watch' }
@@ -47,11 +52,11 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_watcher/watch/#{Utils.__listify(_id)}"
+          path   = "_watcher/watch/#{Utils.listify(_id)}"
           params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found do
+            Utils.rescue_from_not_found do
               Elasticsearch::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )

data/lib/elasticsearch/api/actions/watcher/execute_watch.rb

@@ -15,21 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Forces the execution of a stored watch.
+        # Run a watch.
+        # This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.
+        # For testing and debugging purposes, you also have fine-grained control on how the watch runs.
+        # You can run the watch without running all of its actions or alternatively by simulating them.
+        # You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.
+        # You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.
+        # This serves as great tool for testing and debugging your watches prior to adding them to Watcher.
+        # When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.
+        # If your user is allowed to read index +a+, but not index +b+, then the exact same set of rules will apply during execution of a watch.
+        # When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.
         #
-        # @option arguments [String] :id Watch ID
-        # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode
+        # @option arguments [String] :id The watch identifier.
+        # @option arguments [Boolean] :debug Defines whether the watch runs in debug mode.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Execution control
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-execute-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-execute-watch
         #
         def execute_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.execute_watch' }
@@ -48,7 +57,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = if _id
-                     "_watcher/watch/#{Utils.__listify(_id)}/_execute"
+                     "_watcher/watch/#{Utils.listify(_id)}/_execute"
                    else
                      '_watcher/watch/_execute'
                    end

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

@@ -15,19 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Retrieve settings for the watcher system index
+        # Get Watcher index settings.
+        # Get settings for the Watcher internal index (+.watches+).
+        # Only a subset of settings are shown, for example +index.auto_expand_replicas+ and +index.number_of_replicas+.
         #
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @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.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-settings.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-settings
         #
         def get_settings(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_settings' }
@@ -35,7 +38,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_watcher/settings'

data/lib/elasticsearch/api/actions/watcher/get_watch.rb

@@ -15,19 +15,19 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Retrieves a watch by its ID.
+        # Get a watch.
         #
-        # @option arguments [String] :id Watch ID
+        # @option arguments [String] :id The watch identifier. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch
         #
         def get_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_watch' }
@@ -47,7 +47,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_watcher/watch/#{Utils.__listify(_id)}"
+          path   = "_watcher/watch/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/watcher/put_watch.rb

@@ -15,24 +15,33 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Creates a new watch, or updates an existing one.
+        # Create or update a watch.
+        # When a watch is registered, a new document that represents the watch is added to the +.watches+ index and its trigger is immediately registered with the relevant trigger engine.
+        # Typically for the +schedule+ trigger, the scheduler is the trigger engine.
+        # IMPORTANT: You must use Kibana or this API to create a watch.
+        # Do not add a watch directly to the +.watches+ index by using the Elasticsearch index API.
+        # If Elasticsearch security features are enabled, do not give users write privileges on the +.watches+ index.
+        # When you add a watch you can also define its initial active state by setting the *active* parameter.
+        # When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.
+        # If the user is able to read index +a+, but not index +b+, the same will apply when the watch runs.
         #
-        # @option arguments [String] :id Watch ID
-        # @option arguments [Boolean] :active Specify whether the watch is in/active by default
-        # @option arguments [Number] :version Explicit version number for concurrency control
-        # @option arguments [Number] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number
-        # @option arguments [Number] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term
+        # @option arguments [String] :id The identifier for the watch. (*Required*)
+        # @option arguments [Boolean] :active The initial state of the watch.
+        #  The default value is +true+, which means the watch is active by default. Server default: true.
+        # @option arguments [Integer] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term
+        # @option arguments [Integer] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number
+        # @option arguments [Integer] :version Explicit version number for concurrency control
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The watch
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-put-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-put-watch
         #
         def put_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.put_watch' }
@@ -52,7 +61,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_watcher/watch/#{Utils.__listify(_id)}"
+          path   = "_watcher/watch/#{Utils.listify(_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(