elasticsearch-api 9.0.3 → 9.1.0

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

@@ -28,15 +28,26 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-suggest-user-profiles
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles
         #
         def suggest_user_profiles(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.suggest_user_profiles' }

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

@@ -25,23 +25,34 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-api-key
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key
         #
         def update_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' }
@@ -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,21 +24,33 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-cross-cluster-api-key
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key
         #
         def update_cross_cluster_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_cross_cluster_api_key' }
@@ -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,10 +32,21 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-settings
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings
         #
         def update_settings(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_settings' }

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,10 +42,21 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-user-profile-data
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data
         #
         def update_user_profile_data(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_user_profile_data' }

data/lib/elasticsearch/api/actions/simulate/ingest.rb

@@ -45,10 +45,21 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-simulate-ingest
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest
         #
         def ingest(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'simulate.ingest' }

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

@@ -28,13 +28,24 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-cleanup-repository
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository
         #
         def cleanup_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.cleanup_repository' }

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

@@ -30,11 +30,22 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-clone
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone
         #
         def clone(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.clone' }

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

@@ -31,12 +31,23 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create
         #
         def create(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create' }

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

@@ -25,24 +25,35 @@ 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body repository
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create-repository
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository
         #
         def create_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create_repository' }

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

@@ -26,13 +26,26 @@ module Elasticsearch
         #
         # @option arguments [String] :repository The name of the repository to delete a snapshot from. (*Required*)
         # @option arguments [String] :snapshot A comma-separated list of snapshot names to delete.
-        #  It also accepts wildcards (+*+). (*Required*)
+        #  It also accepts wildcards (`*`). (*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] :wait_for_completion If `true`, the request returns a response when the matching snapshots are all deleted.
+        #  If `false`, the request returns a response as soon as the deletes are scheduled. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete
         #
         def delete(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' }

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

@@ -27,16 +27,27 @@ module Elasticsearch
         # The snapshots themselves are left untouched and in place.
         #
         # @option arguments [String, Array<String>] :repository The ame of the snapshot repositories to unregister.
-        #  Wildcard (+*+) patterns are supported. (*Required*)
+        #  Wildcard (`*`) patterns are supported. (*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.
+        #  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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository
         #
         def delete_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' }

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

@@ -23,43 +23,56 @@ module Elasticsearch
     module Snapshot
       module Actions
         # Get snapshot information.
-        # NOTE: The +after+ parameter and +next+ field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
+        # NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
         # It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.
         # Snapshots concurrently created may be seen during an iteration.
         #
         # @option arguments [String] :repository A comma-separated list of snapshot repository names used to limit the request.
-        #  Wildcard (+*+) expressions are supported. (*Required*)
+        #  Wildcard (`*`) expressions are supported. (*Required*)
         # @option arguments [String, Array<String>] :snapshot A comma-separated list of snapshot names to retrieve
-        #  Wildcards (+*+) are supported.
-        #  - To get information about all snapshots in a registered repository, use a wildcard (+*+) or +_all+.
-        #  - To get information about any snapshots that are currently running, use +_current+. (*Required*)
+        #  Wildcards (`*`) are supported.
+        #  - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.
+        #  - To get information about any snapshots that are currently running, use `_current`. (*Required*)
         # @option arguments [String] :after An offset identifier to start pagination from as returned by the next field in the response body.
         # @option arguments [String] :from_sort_value The value of the current sort column at which to start retrieval.
-        #  It can be a string +snapshot-+ or a repository name when sorting by snapshot or repository name.
-        #  It can be a millisecond time value or a number when sorting by +index-+ or shard count.
-        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error for any snapshots that are unavailable.
-        # @option arguments [Boolean] :index_details If +true+, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.
-        #  The default is +false+, meaning that this information is omitted.
-        # @option arguments [Boolean] :index_names If +true+, the response includes the name of each index in each snapshot. Server default: true.
-        # @option arguments [Boolean] :include_repository If +true+, the response includes the repository name in each snapshot. Server default: true.
+        #  It can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.
+        #  It can be a millisecond time value or a number when sorting by `index-` or shard count.
+        # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error for any snapshots that are unavailable.
+        # @option arguments [Boolean] :index_details If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.
+        #  The default is `false`, meaning that this information is omitted.
+        # @option arguments [Boolean] :index_names If `true`, the response includes the name of each index in each snapshot. Server default: true.
+        # @option arguments [Boolean] :include_repository If `true`, the response includes the repository name in each snapshot. Server default: true.
         # @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 [String] :order The sort order.
-        #  Valid values are +asc+ for ascending and +desc+ for descending order.
+        #  Valid values are `asc` for ascending and `desc` for descending order.
         #  The default behavior is ascending order. Server default: asc.
         # @option arguments [Integer] :offset Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. Server default: 0.
         # @option arguments [Integer] :size The maximum number of snapshots to return.
         #  The default is 0, which means to return all that match the request without limit. Server default: 0.
-        # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.You can use wildcards (+*+) and combinations of wildcards followed by exclude patterns starting with +-+.
-        #  For example, the pattern +*,-policy-a-\*+ will return all snapshots except for those that were created by an SLM policy with a name starting with +policy-a-+.
-        #  Note that the wildcard pattern +*+ matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.
-        #  To include snapshots that were not created by an SLM policy, you can use the special pattern +_none+ that will match all snapshots without an SLM policy.
+        # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.You can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.
+        #  For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.
+        #  Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.
+        #  To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.
         # @option arguments [String] :sort The sort order for the result.
         #  The default behavior is sorting by snapshot start time stamp. Server default: start_time.
-        # @option arguments [Boolean] :verbose If +true+, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters +size+, +order+, +after+, +from_sort_value+, +offset+, +slm_policy_filter+, and +sort+ are not supported when you set +verbose=false+ and the sort order for requests with +verbose=false+ is undefined. Server default: true.
+        # @option arguments [String, Array, Array<String, array>] :state Only return snapshots with a state found in the given comma-separated list of snapshot states.
+        #  The default is all snapshot states.
+        # @option arguments [Boolean] :verbose If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' }

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

@@ -25,15 +25,26 @@ module Elasticsearch
         # Get snapshot repository information.
         #
         # @option arguments [String, Array<String>] :repository A comma-separated list of snapshot repository names used to limit the request.
-        #  Wildcard (+*+) expressions are supported including combining wildcards with exclude patterns starting with +-+.To get information about all snapshot repositories registered in the cluster, omit this parameter or use +*+ or +_all+.
-        # @option arguments [Boolean] :local If +true+, the request gets information from the local node only.
-        #  If +false+, the request gets information from the master node.
+        #  Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.To get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.
+        # @option arguments [Boolean] :local If `true`, the request gets information from the local node only.
+        #  If `false`, the request gets information from the master node.
         # @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: to 30s.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: to 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
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get-repository
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository
         #
         def get_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' }