RubyGems - elasticsearch-api - Versions diffs - 9.0.2 → 9.0.4 - Mend

elasticsearch-api 9.0.2 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (518) hide show

data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb CHANGED Viewed

@@ -27,6 +27,17 @@ module Elasticsearch
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
         # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*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
+        #  `"eixsts_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
         #
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_POST
           path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_update"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb CHANGED Viewed

@@ -31,6 +31,17 @@ module Elasticsearch
         #  Increasing this value generally increases the throughput.
         #  If this setting is greater than the number of hardware threads
         #  it will automatically be changed to a value less than the number of hardware threads. 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
+        #  `"eixsts_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
         #

data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb CHANGED Viewed

@@ -38,6 +38,17 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion When true, the API won’t respond until the upgrade is complete.
         #  Otherwise, it responds as soon as the upgrade task is assigned to a node.
         # @option arguments [Time] :timeout Controls the time to wait for the request to complete. Server default: 30m.
+        # @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
+        #  `"eixsts_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-ml-upgrade-job-snapshot

data/lib/elasticsearch/api/actions/mget.rb CHANGED Viewed

@@ -26,29 +26,40 @@ module Elasticsearch
       # If you specify an index in the request URI, you only need to specify the document IDs in the request body.
       # To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
       # **Filter source fields**
-      # By default, the +_source+ field is returned for every document (if stored).
-      # Use the +_source+ and +_source_include+ or +source_exclude+ attributes to filter what fields are returned for a particular document.
-      # You can include the +_source+, +_source_includes+, and +_source_excludes+ query parameters in the request URI to specify the defaults to use when there are no per-document instructions.
+      # By default, the `_source` field is returned for every document (if stored).
+      # Use the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.
+      # You can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.
       # **Get stored fields**
-      # Use the +stored_fields+ attribute to specify the set of stored fields you want to retrieve.
+      # Use the `stored_fields` attribute to specify the set of stored fields you want to retrieve.
       # Any requested fields that are not stored are ignored.
-      # You can include the +stored_fields+ query parameter in the request URI to specify the defaults to use when there are no per-document instructions.
+      # You can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.
       #
-      # @option arguments [String] :index Name of the index to retrieve documents from when +ids+ are specified, or when a document in the +docs+ array does not specify an index.
+      # @option arguments [String] :index Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.
       # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source?
       #  Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
       #  Fetches with this enabled will be slower the enabling synthetic source natively in the index.
       # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
-      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, the request refreshes relevant shards before retrieving documents.
+      # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If `true`, the request refreshes relevant shards before retrieving documents.
       # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source True or false to return the +_source+ field or not, or a list of fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source True or false to return the `_source` field or not, or 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.
+      #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
       # @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.
-      # @option arguments [String, Array<String>] :stored_fields If +true+, retrieves the document fields stored in the index rather than the document +_source+. Server default: false.
+      #  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.
+      # @option arguments [String, Array<String>] :stored_fields If `true`, retrieves the document fields stored in the index rather than the document `_source`. Server default: false.
+      # @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
+      #  `"eixsts_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
       #

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

@@ -28,6 +28,17 @@ module Elasticsearch
         # You are strongly recommended to use the Upgrade Assistant.
         #
         # @option arguments [String] :index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  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
+        #  `"eixsts_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-migration-deprecations
@@ -53,7 +64,7 @@ module Elasticsearch
                    else
                      '_migration/deprecations'
                    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/migration/get_feature_upgrade_status.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Elasticsearch
         # TIP: This API is designed for indirect use by the Upgrade Assistant.
         # You are strongly recommended to use the Upgrade Assistant.
         #
+        # @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
+        #  `"eixsts_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-migration-get-feature-upgrade-status
@@ -42,7 +53,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_GET
           path   = '_migration/system_features'
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Elasticsearch
         # Some functionality might be temporarily unavailable during the migration process.
         # TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
         #
+        # @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
+        #  `"eixsts_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-migration-get-feature-upgrade-status
@@ -42,7 +53,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_POST
           path   = '_migration/system_features'
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -24,16 +24,22 @@ module Elasticsearch
       # Run multiple searches.
       # The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.
       # The structure is as follows:
-      # +
-      # header\n
-      # body\n
-      # header\n
-      # body\n
-      # +
+      #
+      # ```
+      # header
+      #
+      # body
+      #
+      # header
+      #
+      # body
+      #
+      # ```
+      #
       # This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.
-      # IMPORTANT: 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 requests to this endpoint the +Content-Type+ header should be set to +application/x-ndjson+.
+      # IMPORTANT: 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 requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search.
       # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
@@ -48,13 +54,24 @@ module Elasticsearch
       #  Typically, this adds a small overhead to a request.
       #  However, using computationally expensive named queries on a large number of hits may add significant overhead.
       # @option arguments [Integer] :max_concurrent_searches Maximum number of concurrent searches the multi search API can execute.
-      #  Defaults to +max(1, (# of data nodes * min(search thread pool size, 10)))+.
+      #  Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.
       # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5.
       # @option arguments [Integer] :pre_filter_shard_size Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
       # @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.
       # @option arguments [String] :routing Custom routing value used to route search operations to a specific shard.
       # @option arguments [String] :search_type Indicates whether global term and document frequencies should be used when scoring returned documents.
       # @option arguments [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.
+      # @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
+      #  `"eixsts_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 searches
       #

data/lib/elasticsearch/api/actions/msearch_template.rb CHANGED Viewed

@@ -23,26 +23,38 @@ module Elasticsearch
     module Actions
       # Run multiple templated searches.
       # Run multiple templated searches with a single request.
-      # If you are providing a text file or text input to +curl+, use the +--data-binary+ flag instead of +-d+ to preserve newlines.
+      # If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.
       # For example:
-      # +
+      #
+      # ```
       # $ cat requests
       # { "index": "my-index" }
       # { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
       # { "index": "my-other-index" }
       # { "id": "my-other-search-template", "params": { "query_type": "match_all" }}
       # $ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo
-      # +
+      # ```
       #
       # @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 and indices, omit this parameter or use +*+.
-      # @option arguments [Boolean] :ccs_minimize_roundtrips If +true+, network round-trips are minimized for cross-cluster search requests. Server default: true.
+      #  It supports wildcards (`*`).
+      #  To search all data streams and indices, omit this parameter or use `*`.
+      # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests. Server default: true.
       # @option arguments [Integer] :max_concurrent_searches The maximum number of concurrent searches the API can run.
       # @option arguments [String] :search_type The type of the search operation.
-      # @option arguments [Boolean] :rest_total_hits_as_int If +true+, the response returns +hits.total+ as an integer.
-      #  If +false+, it returns +hits.total+ as an object.
-      # @option arguments [Boolean] :typed_keys If +true+, the response prefixes aggregation and suggester names with their respective types.
+      # @option arguments [Boolean] :rest_total_hits_as_int If `true`, the response returns `hits.total` as an integer.
+      #  If `false`, it returns `hits.total` as an object.
+      # @option arguments [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types.
+      # @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
+      #  `"eixsts_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 search_templates
       #

data/lib/elasticsearch/api/actions/mtermvectors.rb CHANGED Viewed

@@ -25,27 +25,38 @@ module Elasticsearch
       # Get multiple term vectors with a single request.
       # You can specify existing documents by index and ID or provide artificial documents in the body of the request.
       # You can specify the index in the request body or request URI.
-      # The response contains a +docs+ array with all the fetched termvectors.
+      # The response contains a `docs` array with all the fetched termvectors.
       # Each element has the structure provided by the termvectors API.
       # **Artificial documents**
-      # You can also use +mtermvectors+ to generate term vectors for artificial documents provided in the body of the request.
-      # The mapping used is determined by the specified +_index+.
+      # You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.
+      # The mapping used is determined by the specified `_index`.
       #
       # @option arguments [String] :index The name of the index that contains the documents.
       # @option arguments [Array<String>] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
       # @option arguments [String, Array<String>] :fields A comma-separated list or wildcard expressions of fields to include in the statistics.
-      #  It is used as the default list unless a specific field list is provided in the +completion_fields+ or +fielddata_fields+ parameters.
-      # @option arguments [Boolean] :field_statistics If +true+, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Server default: true.
-      # @option arguments [Boolean] :offsets If +true+, the response includes term offsets. Server default: true.
-      # @option arguments [Boolean] :payloads If +true+, the response includes term payloads. Server default: true.
-      # @option arguments [Boolean] :positions If +true+, the response includes term positions. Server default: true.
+      #  It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
+      # @option arguments [Boolean] :field_statistics If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Server default: true.
+      # @option arguments [Boolean] :offsets If `true`, the response includes term offsets. Server default: true.
+      # @option arguments [Boolean] :payloads If `true`, the response includes term payloads. Server default: true.
+      # @option arguments [Boolean] :positions If `true`, the response includes term positions. Server default: true.
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  It is random by default.
       # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Boolean] :term_statistics If true, the response includes term frequency and document frequency.
-      # @option arguments [Integer] :version If +true+, returns the document version as part of a hit.
+      # @option arguments [Integer] :version If `true`, returns the document version as part of a hit.
       # @option arguments [String] :version_type The version type.
+      # @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
+      #  `"eixsts_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
       #

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

@@ -30,7 +30,18 @@ module Elasticsearch
         # support SLA of official GA features.
         #
         # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
-        # @option arguments [Integer] :max_archive_version Specifies the maximum +archive_version+ to be cleared from the archive. (*Required*)
+        # @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*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
+        #  `"eixsts_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-nodes-clear-repositories-metering-archive
@@ -61,7 +72,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_nodes/#{Utils.listify(_node_id)}/_repositories_metering/#{Utils.listify(_max_archive_version)}"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -32,6 +32,17 @@ module Elasticsearch
         # support SLA of official GA features.
         #
         # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  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
+        #  `"eixsts_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-nodes-get-repositories-metering-info
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_GET
           path   = "_nodes/#{Utils.listify(_node_id)}/_repositories_metering"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -36,6 +36,17 @@ module Elasticsearch
         #  before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [String] :type The type to sample. Server default: cpu.
         # @option arguments [String] :sort The sort order for 'cpu' type (default: total)
+        # @option arguments [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
+        #  `"eixsts_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-nodes-hot-threads

data/lib/elasticsearch/api/actions/nodes/info.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.
         # @option arguments [Boolean] :flat_settings If true, returns settings in flat format.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  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
+        #  `"eixsts_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-nodes-info

data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb CHANGED Viewed

@@ -33,6 +33,17 @@ module Elasticsearch
         # @option arguments [String, Array] :node_id The names of particular nodes in the cluster to target.
         # @option arguments [Time] :timeout Period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  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
+        #  `"eixsts_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
         #

data/lib/elasticsearch/api/actions/nodes/stats.rb CHANGED Viewed

@@ -37,7 +37,18 @@ module Elasticsearch
         # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Array<String>] :types A comma-separated list of document types for the indexing index metric.
-        # @option arguments [Boolean] :include_unloaded_segments If +true+, the response includes information from segments that are not loaded into memory.
+        # @option arguments [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory.
+        # @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
+        #  `"eixsts_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-nodes-stats

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

@@ -24,11 +24,22 @@ module Elasticsearch
       module Actions
         # Get feature usage information.
         #
-        # @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information; use +_local+ to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [String, Array<String>] :metric Limits the information returned to the specific metrics.
-        #  A comma-separated list of the following options: +_all+, +rest_actions+.
+        #  A comma-separated list of the following options: `_all`, `rest_actions`.
         # @option arguments [Time] :timeout Period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  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
+        #  `"eixsts_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-nodes-usage

data/lib/elasticsearch/api/actions/open_point_in_time.rb CHANGED Viewed

@@ -26,17 +26,17 @@ module Elasticsearch
       # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
       # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
       # search requests using the same point in time. For example, if refreshes happen between
-      # +search_after+ requests, then the results of those requests might not be consistent as changes happening
+      # `search_after` requests, then the results of those requests might not be consistent as changes happening
       # between searches are only visible to the more recent point in time.
       # A point in time must be opened explicitly before being used in search requests.
-      # A subsequent search request with the +pit+ parameter must not specify +index+, +routing+, or +preference+ values as these parameters are copied from the point in time.
-      # Just like regular searches, you can use +from+ and +size+ to page through point in time search results, up to the first 10,000 hits.
-      # If you want to retrieve more hits, use PIT with +search_after+.
+      # A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.
+      # Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.
+      # If you want to retrieve more hits, use PIT with `search_after`.
       # IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.
-      # When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a +NoShardAvailableActionException+ exception.
+      # When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.
       # To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.
       # **Keeping point in time alive**
-      # The +keep_alive+ parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.
+      # The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.
       # The value does not need to be long enough to process all data — it just needs to be long enough for the next request.
       # Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.
       # Once the smaller segments are no longer needed they are deleted.
@@ -48,19 +48,30 @@ module Elasticsearch
       # Note that a point-in-time doesn't prevent its associated indices from being deleted.
       # You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.
       #
-      # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
+      # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices (*Required*)
       # @option arguments [Time] :keep_alive Extend the length of time that the point in time persists. (*Required*)
-      # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+      # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  By default, it is random.
       # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
       # @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+. Server default: open.
+      #  It supports comma-separated values, such as `open,hidden`. Server default: open.
       # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
-      #  If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
-      #  If +true+, the point in time will contain all the shards that are available at the time of the request.
+      #  If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.
+      #  If `true`, the point in time will contain all the shards that are available at the time of the request.
       # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5.
+      # @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
+      #  `"eixsts_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
       #