elasticsearch-api 9.0.3 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba3a9ad127821bc4aea52dca5080cb467a3c9ac172f14e044c140d27dc2edad
-  data.tar.gz: 022f67f02b02afd828fca2fa6de944faaa34b52d5281ddaacfe9acf21d75cfcf
+  metadata.gz: 454d1a811c49e8943026fa271c34d60c4bb47dc3fb6f7ab7ab2409dfe2051670
+  data.tar.gz: 894456b78b40979d8d45815c08ad5ddae56f2aef0daf26cc2d1bc57113e04763
 SHA512:
-  metadata.gz: 325ecc9b34b8411c75f0218ae61019a5eef98b1fa2d38e8319d5c28ee4a0b7ceaf3ebb162c22dda402924073758627cf71fac65d926673bb639a1e2aec6b0478
-  data.tar.gz: ce44027dcb8c4caedcd8db83fbcafd62949887f23deb93f4f49b4673c96870b6ed2ce337d5fd0135c6d4522343fdcedd213810d4919bfbf10c2d4fd85a109767
+  metadata.gz: 37413722faebeb39855e023aa13984970bebf7d7b8fc89868d47e0f6be489126767ebbf6957ad716c51b89babcf54d69f92d84d1edbd8870e160022e74478bf0
+  data.tar.gz: 4c97c9c557448eeb44627568c3312c054f32a5056ce60d0f00487c4c1c3091afbe3ec00d5c9ce9a91b255dd0df3fe1cbe77cbd91899ce9dc2ac584633010961b

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.env
 .yardoc
 Gemfile.lock
 InstalledFiles

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

@@ -25,12 +25,23 @@ module Elasticsearch
         # Delete an async search.
         # If the asynchronous search is still running, it is cancelled.
         # Otherwise, the saved search results are deleted.
-        # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
+        # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
         #
         # @option arguments [String] :id A unique identifier for the async search. (*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-async-search-submit
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def delete(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' }
@@ -51,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_async_search/#{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/async_search/get.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         #
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)
         # @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
-        #  When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
+        #  When not specified, the `keep_alive` set with the corresponding submit async request will be used.
         #  Otherwise, it is possible to override the value and extend the validity of the request.
         #  When this period expires, the search, if still running, is cancelled.
         #  If the search is completed, its saved results are deleted.
@@ -36,9 +36,20 @@ module Elasticsearch
         # @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
         #  Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
         #  By default no timeout is set meaning that the currently available results will be returned without any additional wait.
+        # @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-async-search-submit
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' }

data/lib/elasticsearch/api/actions/async_search/status.rb

@@ -26,14 +26,25 @@ module Elasticsearch
         # Get the status of a previously submitted async search request given its identifier, without retrieving search results.
         # If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
         # * The user or API key that submitted the original async search request.
-        # * Users that have the +monitor+ cluster privilege or greater privileges.
+        # * Users that have the `monitor` cluster privilege or greater privileges.
         #
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)
         # @option arguments [Time] :keep_alive The length of time that the async search needs to be available.
         #  Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
+        # @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-async-search-submit
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' }

data/lib/elasticsearch/api/actions/async_search/submit.rb

@@ -26,15 +26,15 @@ module Elasticsearch
         # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
         # Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
         # By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
-        # The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
+        # The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
         #
-        # @option arguments [String, Array] :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, Array] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout.
         #  When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
         # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
         #  Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
-        # @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
-        # @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] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
+        # @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] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
         # @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)
@@ -74,11 +74,22 @@ module Elasticsearch
         # @option arguments [String] :q Query in the Lucene query string syntax
         # @option arguments [Integer] :size Number of hits to return (default: 10)
         # @option arguments [Integer] :from Starting offset (default: 0)
-        # @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs
+        # @option arguments [String, Array<String>] :sort A comma-separated list of <field>:<direction> pairs
+        # @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-async-search-submit
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def submit(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' }

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

@@ -22,40 +22,48 @@ module Elasticsearch
   module API
     module Actions
       # Bulk index or delete documents.
-      # Perform multiple +index+, +create+, +delete+, and +update+ actions in a single request.
+      # Perform multiple `index`, `create`, `delete`, and `update` actions in a single request.
       # This reduces overhead and can greatly increase indexing speed.
       # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
-      # * To use the +create+ action, you must have the +create_doc+, +create+, +index+, or +write+ index privilege. Data streams support only the +create+ action.
-      # * To use the +index+ action, you must have the +create+, +index+, or +write+ index privilege.
-      # * To use the +delete+ action, you must have the +delete+ or +write+ index privilege.
-      # * To use the +update+ action, you must have the +index+ or +write+ index privilege.
-      # * To automatically create a data stream or index with a bulk API request, you must have the +auto_configure+, +create_index+, or +manage+ index privilege.
-      # * To make the result of a bulk operation visible to search using the +refresh+ parameter, you must have the +maintenance+ or +manage+ index privilege.
+      # * To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.
+      # * To use the `index` action, you must have the `create`, `index`, or `write` index privilege.
+      # * To use the `delete` action, you must have the `delete` or `write` index privilege.
+      # * To use the `update` action, you must have the `index` or `write` index privilege.
+      # * To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.
+      # * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.
       # Automatic data stream creation requires a matching index template with data stream enabled.
       # The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:
-      # +
-      # action_and_meta_data\n
-      # optional_source\n
-      # action_and_meta_data\n
-      # optional_source\n
+      #
+      # ```
+      # action_and_meta_data
+      #
+      # optional_source
+      #
+      # action_and_meta_data
+      #
+      # optional_source
+      #
       # ....
-      # action_and_meta_data\n
-      # optional_source\n
-      # +
-      # The +index+ and +create+ actions expect a source on the next line and have the same semantics as the +op_type+ parameter in the standard index API.
-      # A +create+ action fails if a document with the same ID already exists in the target
-      # An +index+ action adds or replaces a document as necessary.
-      # NOTE: Data streams support only the +create+ action.
+      # action_and_meta_data
+      #
+      # optional_source
+      #
+      # ```
+      #
+      # The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.
+      # A `create` action fails if a document with the same ID already exists in the target
+      # An `index` action adds or replaces a document as necessary.
+      # NOTE: Data streams support only the `create` action.
       # To update or delete a document in a data stream, you must target the backing index containing the document.
-      # An +update+ action expects that the partial doc, upsert, and script and its options are specified on the next line.
-      # A +delete+ action does not expect a source on the next line and has the same semantics as the standard delete API.
-      # NOTE: The final line of data must end with a newline character (+\n+).
-      # Each newline character may be preceded by a carriage return (+\r+).
-      # When sending NDJSON data to the +_bulk+ endpoint, use a +Content-Type+ header of +application/json+ or +application/x-ndjson+.
-      # Because this format uses literal newline characters (+\n+) as delimiters, make sure that the JSON actions and sources are not pretty printed.
-      # If you provide a target in the request path, it is used for any actions that don't explicitly specify an +_index+ argument.
+      # An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.
+      # A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.
+      # NOTE: The final line of data must end with a newline character (`\n`).
+      # Each newline character may be preceded by a carriage return (`\r`).
+      # When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.
+      # Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.
+      # If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.
       # A note on the format: the idea here is to make processing as fast as possible.
-      # As some of the actions are redirected to other shards on other nodes, only +action_meta_data+ is parsed on the receiving node side.
+      # As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.
       # Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.
       # There is no "correct" number of actions to perform in a single bulk request.
       # Experiment with different settings to find the optimal size for your particular workload.
@@ -64,73 +72,88 @@ module Elasticsearch
       # For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.
       # **Client suppport for bulk requests**
       # Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:
-      # * Go: Check out +esutil.BulkIndexer+
-      # * Perl: Check out +Search::Elasticsearch::Client::5_0::Bulk+ and +Search::Elasticsearch::Client::5_0::Scroll+
-      # * Python: Check out +elasticsearch.helpers.*+
-      # * JavaScript: Check out +client.helpers.*+
-      # * .NET: Check out +BulkAllObservable+
+      # * Go: Check out `esutil.BulkIndexer`
+      # * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`
+      # * Python: Check out `elasticsearch.helpers.*`
+      # * JavaScript: Check out `client.helpers.*`
+      # * .NET: Check out `BulkAllObservable`
       # * PHP: Check out bulk indexing.
       # **Submitting bulk requests with cURL**
-      # If you're providing text file input to +curl+, you must use the +--data-binary+ flag instead of plain +-d+.
+      # If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
       # The latter doesn't preserve newlines. For example:
-      # +
+      #
+      # ```
       # $ cat requests
       # { "index" : { "_index" : "test", "_id" : "1" } }
       # { "field1" : "value1" }
       # $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo
       # {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}
-      # +
+      # ```
+      #
       # **Optimistic concurrency control**
-      # Each +index+ and +delete+ action within a bulk API call may include the +if_seq_no+ and +if_primary_term+ parameters in their respective action and meta data lines.
-      # The +if_seq_no+ and +if_primary_term+ parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.
+      # Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.
+      # The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.
       # **Versioning**
-      # Each bulk item can include the version value using the +version+ field.
-      # It automatically follows the behavior of the index or delete operation based on the +_version+ mapping.
-      # It also support the +version_type+.
+      # Each bulk item can include the version value using the `version` field.
+      # It automatically follows the behavior of the index or delete operation based on the `_version` mapping.
+      # It also support the `version_type`.
       # **Routing**
-      # Each bulk item can include the routing value using the +routing+ field.
-      # It automatically follows the behavior of the index or delete operation based on the +_routing+ mapping.
-      # NOTE: Data streams do not support custom routing unless they were created with the +allow_custom_routing+ setting enabled in the template.
+      # Each bulk item can include the routing value using the `routing` field.
+      # It automatically follows the behavior of the index or delete operation based on the `_routing` mapping.
+      # NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.
       # **Wait for active shards**
-      # When making bulk calls, you can set the +wait_for_active_shards+ parameter to require a minimum number of shard copies to be active before starting to process the bulk request.
+      # When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.
       # **Refresh**
       # Control when the changes made by this request are visible to search.
       # NOTE: Only the shards that receive the bulk request will be affected by refresh.
-      # Imagine a +_bulk?refresh=wait_for+ request with three documents in it that happen to be routed to different shards in an index with five shards.
+      # Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.
       # The request will only wait for those three shards to refresh.
-      # The other two shards that make up the index do not participate in the +_bulk+ request at all.
+      # The other two shards that make up the index do not participate in the `_bulk` request at all.
+      # You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.
+      # Refer to the linked documentation for step-by-step instructions using the index settings API.
       #
       # @option arguments [String] :index The name of the data stream, index, or index alias to perform bulk actions on.
       # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
-      # @option arguments [Boolean] :list_executed_pipelines If +true+, the response will include the ingest pipelines that were run for each index or create.
+      # @option arguments [Boolean] :list_executed_pipelines If `true`, the response will include the ingest pipelines that were run for each index or create.
       # @option arguments [String] :pipeline The pipeline identifier to use to preprocess incoming documents.
-      #  If the index has a default ingest pipeline specified, setting the value to +_none+ turns off the default ingest pipeline for this request.
+      #  If the index has a default ingest pipeline specified, setting the value to `_none` turns off 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] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search.
-      #  If +wait_for+, wait for a refresh to make this operation visible to search.
-      #  If +false+, do nothing with refreshes.
-      #  Valid values: +true+, +false+, +wait_for+. Server default: false.
+      # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If `wait_for`, wait for a refresh to make this operation visible to search.
+      #  If `false`, do nothing with refreshes.
+      #  Valid values: `true`, `false`, `wait_for`. Server default: false.
       # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or contains a list of fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
-      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
-      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can exclude fields from this subset using the `_source_excludes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [Time] :timeout The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.
-      #  The default is +1m+ (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.
+      #  The default is `1m` (one minute), which 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 [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 default is +1+, which waits for each primary shard to be active. Server default: 1.
-      # @option arguments [Boolean] :require_alias If +true+, the request's actions must target an index alias.
-      # @option arguments [Boolean] :require_data_stream If +true+, the request's actions must target a data stream (existing or to be created).
+      #  Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+      #  The default is `1`, which waits for each primary shard to be active. Server default: 1.
+      # @option arguments [Boolean] :require_alias If `true`, the request's actions must target an index alias.
+      # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
+      # @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 [String|Array] :body operations. Array of Strings, Header/Data pairs, or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.bulkify documentation.
       #
-      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-bulk
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk
       #
       def bulk(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'bulk' }

data/lib/elasticsearch/api/actions/cat/aliases.rb

@@ -27,25 +27,36 @@ module Elasticsearch
         # This API does not return data stream aliases.
         # IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
         #
-        # @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (+*+).  To retrieve all aliases, omit this parameter or use +*+ or +_all+.
+        # @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
-        #  Sorting defaults to ascending and can be changed by setting +:asc+
-        #  or +:desc+ as a suffix to the column name.
+        #  Sorting defaults to ascending and can be changed by setting `:asc`
+        #  or `:desc` as a suffix to the column name.
         # @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+.
+        #  It supports comma-separated values, such as `open,hidden`.
         # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
         #  If the master node is not available before the timeout expires, the request fails and returns an error.
-        #  To indicated that the request should never timeout, you can set it to +-1+. Server default: 30s.
+        #  To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
-        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
-        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
+        # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
+        # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @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-cat-aliases
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases
         #
         def aliases(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' }

data/lib/elasticsearch/api/actions/cat/allocation.rb

@@ -30,21 +30,32 @@ module Elasticsearch
         # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
-        #  Sorting defaults to ascending and can be changed by setting +:asc+
-        #  or +:desc+ as a suffix to the column name.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  Sorting defaults to ascending and can be changed by setting `:asc`
+        #  or `:desc` as a suffix to the column name.
+        # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
+        #  local cluster state. If `false` the list of selected nodes are computed
         #  from the cluster state of the master node. In both cases the coordinating
         #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
-        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
-        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
+        # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
+        # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @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-cat-allocation
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation
         #
         def allocation(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.allocation' }

data/lib/elasticsearch/api/actions/cat/component_templates.rb

@@ -33,21 +33,32 @@ module Elasticsearch
         #  If it is omitted, all component templates are returned.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
-        #  Sorting defaults to ascending and can be changed by setting +:asc+
-        #  or +:desc+ as a suffix to the column name.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  Sorting defaults to ascending and can be changed by setting `:asc`
+        #  or `:desc` as a suffix to the column name.
+        # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
+        #  local cluster state. If `false` the list of selected nodes are computed
         #  from the cluster state of the master node. In both cases the coordinating
         #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
-        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
-        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
+        # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
+        # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @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-cat-component-templates
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates
         #
         def component_templates(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' }

data/lib/elasticsearch/api/actions/cat/count.rb

@@ -29,20 +29,31 @@ module Elasticsearch
         # They are not intended for use by applications. For application consumption, use the count API.
         #
         # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
-        #  It supports wildcards (+*+).
-        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        #  It supports wildcards (`*`).
+        #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
-        #  Sorting defaults to ascending and can be changed by setting +:asc+
-        #  or +:desc+ as a suffix to the column name.
+        #  Sorting defaults to ascending and can be changed by setting `:asc`
+        #  or `:desc` as a suffix to the column name.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
-        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
-        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
+        # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
+        # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @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-cat-count
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count
         #
         def count(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.count' }

data/lib/elasticsearch/api/actions/cat/fielddata.rb

@@ -32,16 +32,27 @@ module Elasticsearch
         # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
-        #  Sorting defaults to ascending and can be changed by setting +:asc+
-        #  or +:desc+ as a suffix to the column name.
+        #  Sorting defaults to ascending and can be changed by setting `:asc`
+        #  or `:desc` as a suffix to the column name.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
-        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
-        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
+        # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
+        # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @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-cat-fielddata
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata
         #
         def fielddata(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.fielddata' }