elasticsearch-api 9.0.3 → 9.1.0

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

@@ -23,7 +23,7 @@ module Elasticsearch
     module Actions
       # Update a document.
       # Update a document by running a script or passing a partial document.
-      # If the Elasticsearch security features are enabled, you must have the +index+ or +write+ index privilege for the target index or index alias.
+      # If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.
       # The script can update, delete, or skip modifying the document.
       # The API also supports passing a partial document, which is merged into the existing document.
       # To fully replace an existing document, use the index API.
@@ -32,8 +32,9 @@ module Elasticsearch
       # * Runs the specified script.
       # * Indexes the result.
       # The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.
-      # The +_source+ field must be enabled to use this API.
-      # In addition to +_source+, you can access the following variables through the +ctx+ map: +_index+, +_type+, +_id+, +_version+, +_routing+, and +_now+ (the current timestamp).
+      # The `_source` field must be enabled to use this API.
+      # In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).
+      # For usage examples such as partial updates, upserts, and scripted updates, see the External documentation.
       #
       # @option arguments [String] :id A unique identifier for the document to be updated. (*Required*)
       # @option arguments [String] :index The name of the target index.
@@ -45,23 +46,34 @@ module Elasticsearch
       # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
       #  If 'wait_for', it waits for a refresh to make this operation visible to search.
       #  If 'false', it does nothing with refreshes. Server default: false.
-      # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
+      # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias.
       # @option arguments [Integer] :retry_on_conflict The number of times the operation should be retried when a conflict occurs. Server default: 0.
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Time] :timeout The period to wait for the following operations: dynamic mapping updates and waiting for active shards.
       #  Elasticsearch waits for at least the timeout period before failing.
       #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
       # @option arguments [Integer, String] :wait_for_active_shards The number of copies of each shard 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 default value of +1+ means it waits for each primary shard to be active. Server default: 1.
-      # @option arguments [Boolean, String, Array<String>] :_source If +false+, source retrieval is turned off.
+      #  Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).
+      #  The default value of `1` means it waits for each primary shard to be active. Server default: 1.
+      # @option arguments [Boolean, String, Array<String>] :_source If `false`, source retrieval is turned off.
       #  You can also specify a comma-separated list of the fields you want to retrieve. Server default: true.
       # @option arguments [String, Array<String>] :_source_excludes The source fields you want to exclude.
       # @option arguments [String, Array<String>] :_source_includes The source fields you want to retrieve.
+      # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update
       #
       def update(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update' }

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

@@ -25,98 +25,107 @@ module Elasticsearch
       # 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+
+      # * `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.
+      # 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.
+      # **Refreshing shards**
+      # Specifying the `refresh` parameter refreshes all shards once the request completes.
+      # This is different to the update API's `refresh` parameter, which causes only the shard
+      # that received the request to be refreshed. Unlike the update API, it does not support
+      # `wait_for`.
+      # **Running update by query asynchronously**
+      # If the request contains `wait_for_completion=false`, Elasticsearch
+      # performs some preflight checks, launches the request, and returns a
+      # {https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks task} 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}`.
+      # **Waiting for active shards**
+      # `wait_for_active_shards` controls how many copies of a shard must be active
+      # before proceeding with the request. See {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards `wait_for_active_shards`}
+      # for details. `timeout` controls how long each write request waits for unavailable
+      # shards to become available. Both work exactly the way they work in the
+      # {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk Bulk API}. Update by query uses scrolled searches, so you can also
+      # specify the `scroll` parameter to control how long it keeps the search context
+      # alive, for example `?scroll=10m`. The default is 5 minutes.
       # **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.
+      # 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.
+      # 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+:
-      # +
+      # 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.
+      # 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:
+      # 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.
+      # * 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.
+      # * 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.
+      # * 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.
+      # Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API:
       #
       # @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.
+      #  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.
+      #  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.
+      #  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.
+      #  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+.
+      #  It supports comma-separated values, such as `open,hidden`.
       # @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 [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.
+      #  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 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.
+      # @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.
@@ -124,10 +133,10 @@ module Elasticsearch
       # @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 [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 [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.
@@ -138,19 +147,30 @@ module Elasticsearch
       #  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 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 [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.
+      #  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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query
       #
       def update_by_query(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update_by_query' }

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

@@ -27,10 +27,21 @@ module Elasticsearch
       #
       # @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.
+      #  To turn off throttling, set it to `-1`. Server default: -1.
+      # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query-rethrottle
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle
       #
       def update_by_query_rethrottle(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' }

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

@@ -24,18 +24,30 @@ module Elasticsearch
       module 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.
+        # 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+.
+        # 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).
+        # To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.
         #
         # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch
         #
         def ack_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' }
@@ -62,7 +74,7 @@ module Elasticsearch
                    else
                      "_watcher/watch/#{Utils.listify(_watch_id)}/_ack"
                    end
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -26,9 +26,20 @@ module Elasticsearch
         # A watch can be either active or inactive.
         #
         # @option arguments [String] :watch_id The watch identifier. (*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
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-activate-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch
         #
         def activate_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' }
@@ -49,7 +60,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_watcher/watch/#{Utils.listify(_watch_id)}/_activate"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -26,9 +26,20 @@ module Elasticsearch
         # A watch can be either active or inactive.
         #
         # @option arguments [String] :watch_id The watch identifier. (*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
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-deactivate-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch
         #
         def deactivate_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.deactivate_watch' }
@@ -49,7 +60,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_watcher/watch/#{Utils.listify(_watch_id)}/_deactivate"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -23,16 +23,27 @@ module Elasticsearch
     module Watcher
       module Actions
         # 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.
+        # 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.
+        # 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 The watch identifier. (*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
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-delete-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch
         #
         def delete_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.delete_watch' }

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

@@ -30,15 +30,27 @@ module Elasticsearch
         # 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.
+        # 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.
+        # Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.
         #
         # @option arguments [String] :id The watch identifier.
         # @option arguments [Boolean] :debug Defines whether the watch runs in debug mode.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-execute-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch
         #
         def execute_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.execute_watch' }

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

@@ -23,14 +23,25 @@ module Elasticsearch
     module Watcher
       module Actions
         # 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+.
+        # 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 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-settings
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings
         #
         def get_settings(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_settings' }

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

@@ -25,9 +25,20 @@ module Elasticsearch
         # Get a watch.
         #
         # @option arguments [String] :id The watch identifier. (*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
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch
         #
         def get_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_watch' }
@@ -48,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_watcher/watch/#{Utils.listify(_id)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -23,25 +23,36 @@ module Elasticsearch
     module Watcher
       module Actions
         # 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.
+        # 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.
+        # 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.
+        # 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 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.
+        #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-put-watch
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch
         #
         def put_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.put_watch' }