elasticsearch-api 9.0.3 → 9.0.4

data/lib/elasticsearch/api/actions/security/put_user.rb

@@ -30,8 +30,19 @@ module Elasticsearch
         # @option arguments [String] :username An identifier for the user.NOTE: Usernames must be at least 1 and no more than 507 characters.
         #  They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.
         #  Leading or trailing whitespace is not allowed. (*Required*)
-        # @option arguments [String] :refresh Valid values are +true+, +false+, and +wait_for+.
+        # @option arguments [String] :refresh Valid values are `true`, `false`, and `wait_for`.
         #  These values have the same meaning as in the index API, but the default value for this API is true. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"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/security/query_api_keys.rb

@@ -25,16 +25,28 @@ module Elasticsearch
         # Find API keys with a query.
         # Get a paginated list of API keys and their information.
         # You can optionally filter the results with a query.
-        # To use this API, you must have at least the +manage_own_api_key+ or the +read_security+ cluster privileges.
-        # If you have only the +manage_own_api_key+ privilege, this API returns only the API keys that you own.
-        # If you have the +read_security+, +manage_api_key+, or greater privileges (including +manage_security+), this API returns all API keys regardless of ownership.
+        # To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
+        # If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
+        # If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
+        # Refer to the linked documentation for examples of how to find API keys:
         #
         # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
         #  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).
-        #  An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has +manage_api_key+ or higher privileges.
+        #  An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.
         # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile UID for the API key owner principal.
-        #  If it exists, the profile UID is returned under the +profile_uid+ response field for each API key.
+        #  If it exists, the profile UID is returned under the `profile_uid` response field for each API key.
         # @option arguments [Boolean] :typed_keys Determines whether aggregation names are 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 request body
         #

data/lib/elasticsearch/api/actions/security/query_role.rb

@@ -29,6 +29,17 @@ module Elasticsearch
         # You can optionally filter the results with a query.
         # Also, the results can be paginated and sorted.
         #
+        # @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
         #
@@ -49,7 +60,7 @@ module Elasticsearch
                    end
 
           path   = '_security/_query/role'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/query_user.rb

@@ -29,6 +29,17 @@ module Elasticsearch
         # This API is only for native users.
         #
         # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users.
+        # @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/security/saml_authenticate.rb

@@ -29,10 +29,21 @@ module Elasticsearch
         # The SAML message that is submitted can be:
         # * A response to a SAML authentication request that was previously created using the SAML prepare authentication API.
         # * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.
-        # In either case, the SAML message needs to be a base64 encoded XML document with a root element of +<Response>+.
+        # In either case, the SAML message needs to be a base64 encoded XML document with a root element of `<Response>`.
         # After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.
         # This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.
         #
+        # @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
         #
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/authenticate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb

@@ -32,6 +32,17 @@ module Elasticsearch
         # The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.
         # The caller of this API must prepare the request accordingly so that this API can handle either of them.
         #
+        # @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
         #
@@ -49,7 +60,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/complete_logout'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_invalidate.rb

@@ -27,10 +27,21 @@ module Elasticsearch
         # NOTE: This API is intended for use by custom web applications other than Kibana.
         # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
         # The logout request comes from the SAML IdP during an IdP initiated Single Logout.
-        # The custom web application can use this API to have Elasticsearch process the +LogoutRequest+.
+        # The custom web application can use this API to have Elasticsearch process the `LogoutRequest`.
         # After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.
         # Thus the user can be redirected back to their IdP.
         #
+        # @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
         #
@@ -48,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/invalidate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_logout.rb

@@ -29,6 +29,17 @@ module Elasticsearch
         # This API invalidates the tokens that were generated for a user by the SAML authenticate API.
         # If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).
         #
+        # @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
         #
@@ -46,7 +57,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/logout'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb

@@ -23,17 +23,28 @@ module Elasticsearch
     module Security
       module Actions
         # Prepare SAML authentication.
-        # Create a SAML authentication request (+<AuthnRequest>+) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
+        # Create a SAML authentication request (`<AuthnRequest>`) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
         # NOTE: This API is intended for use by custom web applications other than Kibana.
         # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
         # This API returns a URL pointing to the SAML Identity Provider.
         # You can use the URL to redirect the browser of the user in order to continue the authentication process.
-        # The URL includes a single parameter named +SAMLRequest+, which contains a SAML Authentication request that is deflated and Base64 encoded.
-        # If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named +SigAlg+ and +Signature+.
+        # The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.
+        # If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.
         # These parameters contain the algorithm used for the signature and the signature value itself.
         # It also returns a random string that uniquely identifies this SAML Authentication request.
         # The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.
         #
+        # @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
         #
@@ -51,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/prepare'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb

@@ -28,6 +28,17 @@ module Elasticsearch
         # This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.
         #
         # @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*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-security-saml-service-provider-metadata
@@ -51,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_security/saml/metadata/#{Utils.listify(_realm_name)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb

@@ -28,11 +28,22 @@ module Elasticsearch
         # Individual users and external applications should not call this API directly.
         # Elastic reserves the right to change or remove this feature in future releases without prior notice.
         #
-        # @option arguments [String] :data A comma-separated list of filters for the +data+ field of the profile document.
-        #  To return all content use +data=*+.
-        #  To return a subset of content, use +data=<key>+ to retrieve content nested under the specified +<key>+.
-        #  By default, the API returns no +data+ content.
-        #  It is an error to specify +data+ as both the query parameter and the request body field.
+        # @option arguments [String, Array<String>] :data A comma-separated list of filters for the `data` field of the profile document.
+        #  To return all content use `data=*`.
+        #  To return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.
+        #  By default, the API returns no `data` content.
+        #  It is an error to specify `data` as both the query parameter and the request body field.
+        # @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/security/update_api_key.rb

@@ -25,19 +25,30 @@ module Elasticsearch
         # Update an API key.
         # Update attributes of an existing API key.
         # This API supports updates to an API key's access scope, expiration, and metadata.
-        # To use this API, you must have at least the +manage_own_api_key+ cluster privilege.
+        # To use this API, you must have at least the `manage_own_api_key` cluster privilege.
         # Users can only update API keys that they created or that were granted to them.
-        # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.
         # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
         # Use this API to update API keys created by the create API key or grant API Key APIs.
         # If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
         # It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
-        # The access scope of an API key is derived from the +role_descriptors+ you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+        # The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.
         # The snapshot of the owner's permissions is updated automatically on every call.
-        # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change the API key's access scope.
+        # IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.
         # This change can occur if the owner user's permissions have changed since the API key was created or last modified.
         #
         # @option arguments [String] :id The ID of the API key to update. (*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
         #
@@ -62,7 +73,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_security/api_key/#{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/security/update_cross_cluster_api_key.rb

@@ -24,17 +24,29 @@ module Elasticsearch
       module Actions
         # Update a cross-cluster API key.
         # Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.
-        # To use this API, you must have at least the +manage_security+ cluster privilege.
+        # To use this API, you must have at least the `manage_security` cluster privilege.
         # Users can only update API keys that they created.
-        # To update another user's API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # To update another user's API key, use the `run_as` feature to submit a request on behalf of another user.
         # IMPORTANT: It's not possible to use an API key as the authentication credential for this API.
         # To update an API key, the owner user's credentials are required.
         # It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.
         # This API supports updates to an API key's access scope, metadata, and expiration.
-        # The owner user's information, such as the +username+ and +realm+, is also updated automatically on every call.
+        # The owner user's information, such as the `username` and `realm`, is also updated automatically on every call.
         # NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.
+        # To learn more about how to use this API, refer to the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples Update cross cluter API key API examples page}.
         #
         # @option arguments [String] :id The ID of the cross-cluster API key to update. (*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
         #
@@ -60,7 +72,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_security/cross_cluster/api_key/#{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/security/update_settings.rb

@@ -23,8 +23,8 @@ module Elasticsearch
     module Security
       module Actions
         # Update security index settings.
-        # Update the user-configurable settings for the security internal index (+.security+ and associated indices). Only a subset of settings are allowed to be modified. This includes +index.auto_expand_replicas+ and +index.number_of_replicas+.
-        # NOTE: If +index.auto_expand_replicas+ is set, +index.number_of_replicas+ will be ignored during updates.
+        # Update the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.
+        # NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.
         # If a specific index is not in use on the system and settings are provided for it, the request will be rejected.
         # This API does not yet support configuring the settings for indices before they are in use.
         #
@@ -32,6 +32,17 @@ module Elasticsearch
         #  If no response is received before the timeout expires, the request fails and returns an error.
         # @option arguments [Time] :timeout The period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"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/security/update_user_profile_data.rb

@@ -28,12 +28,12 @@ module Elasticsearch
         # Individual users and external applications should not call this API directly.
         # Elastic reserves the right to change or remove this feature in future releases without prior notice.
         # To use this API, you must have one of the following privileges:
-        # * The +manage_user_profile+ cluster privilege.
-        # * The +update_profile_data+ global privilege for the namespaces that are referenced in the request.
-        # This API updates the +labels+ and +data+ fields of an existing user profile document with JSON objects.
+        # * The `manage_user_profile` cluster privilege.
+        # * The `update_profile_data` global privilege for the namespaces that are referenced in the request.
+        # This API updates the `labels` and `data` fields of an existing user profile document with JSON objects.
         # New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.
         # For both labels and data, content is namespaced by the top-level fields.
-        # The +update_profile_data+ global privilege grants privileges for updating only the allowed namespaces.
+        # The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.
         #
         # @option arguments [String] :uid A unique identifier for the user profile. (*Required*)
         # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
@@ -42,6 +42,17 @@ module Elasticsearch
         #  visible to search.
         #  If 'wait_for', it waits for a refresh to make this operation visible to search.
         #  If 'false', nothing is done with refreshes. 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/simulate/ingest.rb

@@ -45,6 +45,17 @@ module Elasticsearch
         #  If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.
         # @option arguments [String] :pipeline The pipeline to use as the default pipeline.
         #  This value can be used to override the default pipeline of the index.
+        # @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/snapshot/cleanup_repository.rb

@@ -28,10 +28,21 @@ module Elasticsearch
         # @option arguments [String] :repository The name of the snapshot repository to clean up. (*Required*)
         # @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 indicate that the request should never timeout, set it to +-1+ Server default: 30s.
+        #  To indicate that the request should never timeout, set it to `-1` Server default: 30s.
         # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
         #  If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        #  To indicate that the request should never timeout, set it to `-1`. 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-snapshot-cleanup-repository

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

@@ -30,7 +30,18 @@ module Elasticsearch
         # @option arguments [String] :target_snapshot The target snapshot name. (*Required*)
         # @option arguments [Time] :master_timeout The period to wait for the master node.
         #  If the master node is not available before the timeout expires, the request fails and returns an error.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        #  To indicate that the request should never timeout, set it to `-1`. 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/snapshot/create.rb

@@ -31,8 +31,19 @@ module Elasticsearch
         #  It must be unique in the repository. (*Required*)
         # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
-        # @option arguments [Boolean] :wait_for_completion If +true+, the request returns a response when the snapshot is complete.
-        #  If +false+, the request returns a response when the snapshot initializes.
+        # @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the snapshot is complete.
+        #  If `false`, the request returns a response when the snapshot initializes.
+        # @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/snapshot/create_repository.rb

@@ -25,20 +25,31 @@ module Elasticsearch
         # Create or update a snapshot repository.
         # IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
         # To register a snapshot repository, the cluster's global metadata must be writeable.
-        # Ensure there are no cluster blocks (for example, +cluster.blocks.read_only+ and +clsuter.blocks.read_only_allow_delete+ settings) that prevent write access.
+        # Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.
         # Several options for this API can be specified using a query parameter or a request body parameter.
         # If both parameters are specified, only the query parameter is used.
         #
         # @option arguments [String] :repository The name of the snapshot repository to register or update. (*Required*)
         # @option arguments [Time] :master_timeout The period to wait for the master node.
         #  If the master node is not available before the timeout expires, the request fails and returns an error.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
         # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
         #  If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
-        # @option arguments [Boolean] :verify If +true+, the request verifies the repository is functional on all master and data nodes in the cluster.
-        #  If +false+, this verification is skipped.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
+        # @option arguments [Boolean] :verify If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.
+        #  If `false`, this verification is skipped.
         #  You can also perform this verification with the verify snapshot repository API. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"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 repository
         #