elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,21 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Update settings for the security system index
+        # 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.
+        # 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.
         #
-        # @option arguments [Time] :master_timeout Timeout for connection to master
-        # @option arguments [Time] :timeout Timeout for acknowledgements from all nodes
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        # @option arguments [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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body An object with the new settings for each index, if any (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-settings.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-settings
         #
         def update_settings(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_settings' }
@@ -39,7 +45,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_PUT
           path   = '_security/settings'

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

@@ -15,23 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Update application specific data for the user profile of the given unique ID.
+        # Update user profile data.
+        # Update specific data for the user profile that is associated with a unique ID.
+        # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.
+        # 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.
+        # 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.
         #
-        # @option arguments [String] :uid An unique identifier of the user profile
-        # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
-        # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
-        # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
+        # @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.
+        # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation
+        #  visible to search.
+        #  If 'wait_for', it waits for a refresh to make this operation visible to search.
+        #  If 'false', nothing is done with refreshes. Server default: false.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The application data to update (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-user-profile-data.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-user-profile-data
         #
         def update_user_profile_data(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_user_profile_data' }
@@ -47,12 +61,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           _uid = arguments.delete(:uid)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/profile/#{Utils.__listify(_uid)}/_data"
+          path   = "_security/profile/#{Utils.listify(_uid)}/_data"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,25 +15,40 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Simulate
       module Actions
-        # Simulates running ingest with example documents.
+        # Simulate data ingestion.
+        # Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.
+        # This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.
+        # The API runs the default and final pipeline for that index against a set of documents provided in the body of the request.
+        # If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.
+        # No data is indexed into Elasticsearch.
+        # Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.
+        # The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.
+        # This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.
+        # The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.
+        # By default, the pipeline definitions that are currently in the system are used.
+        # However, you can supply substitute pipeline definitions in the body of the request.
+        # These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [String] :index Default index for docs which don't provide one
-        # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document
+        # @option arguments [String] :index The index to simulate ingesting into.
+        #  This value can be overridden by specifying an index on each document.
+        #  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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The simulate definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/simulate-ingest-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-simulate-ingest
         #
         def ingest(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'simulate.ingest' }
@@ -48,13 +63,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "_ingest/#{Utils.__listify(_index)}/_simulate"
+                     "_ingest/#{Utils.listify(_index)}/_simulate"
                    else
                      '_ingest/_simulate'
                    end

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

@@ -15,21 +15,26 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Removes stale data from repository.
+        # Clean up the snapshot repository.
+        # Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @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.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clean-up-snapshot-repo-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-cleanup-repository
         #
         def cleanup_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.cleanup_repository' }
@@ -49,7 +54,7 @@ module Elasticsearch
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_cleanup"
+          path   = "_snapshot/#{Utils.listify(_repository)}/_cleanup"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,28 +15,31 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Clones indices from one snapshot into another snapshot in the same repository.
+        # Clone a snapshot.
+        # Clone part of all of a snapshot into another snapshot in the same repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [String] :snapshot The name of the snapshot to clone from
-        # @option arguments [String] :target_snapshot The name of the cloned snapshot to create
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :repository The name of the snapshot repository that both source and target snapshot belong to. (*Required*)
+        # @option arguments [String] :snapshot The source snapshot name. (*Required*)
+        # @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.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot clone definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-clone
         #
         def clone(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.clone' }
 
-          defined_params = %i[repository snapshot target_snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot, :target_snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -58,7 +61,7 @@ module Elasticsearch
           _target_snapshot = arguments.delete(:target_snapshot)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_clone/#{Utils.__listify(_target_snapshot)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_clone/#{Utils.listify(_target_snapshot)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,28 +15,33 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Creates a snapshot in a repository.
+        # Create a snapshot.
+        # Take a snapshot of a cluster or of data streams and indices.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [String] :snapshot A snapshot name
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [String] :repository The name of the repository for the snapshot. (*Required*)
+        # @option arguments [String] :snapshot The name of the snapshot.
+        #  It supportes date math.
+        #  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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot definition
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create
         #
         def create(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create' }
 
-          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -54,7 +59,7 @@ module Elasticsearch
           _snapshot = arguments.delete(:snapshot)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,23 +15,34 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Creates a repository.
+        # 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.
+        # 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 A repository name
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :verify Whether to verify the repository after creation
+        # @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.
+        # @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.
+        #  You can also perform this verification with the verify snapshot repository API. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The repository definition (*Required*)
+        # @option arguments [Hash] :body repository
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create-repository
         #
         def create_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create_repository' }
@@ -52,7 +63,7 @@ module Elasticsearch
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,29 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Deletes one or more snapshots.
+        # Delete snapshots.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @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*)
+        # @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.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete
         #
         def delete(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' }
 
-          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -53,11 +55,11 @@ module Elasticsearch
           _snapshot = arguments.delete(:snapshot)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}"
           params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found do
+            Utils.rescue_from_not_found do
               Elasticsearch::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )

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

@@ -15,21 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Deletes a repository.
+        # Delete snapshot repositories.
+        # When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
+        # The snapshots themselves are left untouched and in place.
         #
-        # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String, Array<String>] :repository The ame of the snapshot repositories to unregister.
+        #  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.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository
         #
         def delete_repository(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' }
@@ -49,11 +56,11 @@ module Elasticsearch
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_snapshot/#{Utils.__listify(_repository)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}"
           params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found do
+            Utils.rescue_from_not_found do
               Elasticsearch::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )

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

@@ -15,38 +15,56 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Snapshot
       module Actions
-        # Returns information about a snapshot.
+        # 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.
+        # 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 repository name
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
-        # @option arguments [Boolean] :index_names Whether to include the name of each index in the snapshot. Defaults to true.
-        # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
-        # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
-        # @option arguments [String] :sort Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count)
-        # @option arguments [Integer] :size Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
-        # @option arguments [String] :order Sort order (options: asc, desc)
-        # @option arguments [String] :from_sort_value Value of the current sort column at which to start retrieval.
-        # @option arguments [String] :after Offset identifier to start pagination from as returned by the 'next' field in the response body.
-        # @option arguments [Integer] :offset Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0
-        # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy
-        # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
+        # @option arguments [String] :repository A comma-separated list of snapshot repository names used to limit the request.
+        #  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*)
+        # @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.
+        # @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.
+        #  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] :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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' }
 
-          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+          defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -64,11 +82,11 @@ module Elasticsearch
           _snapshot = arguments.delete(:snapshot)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
+          path   = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}"
           params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found do
+            Utils.rescue_from_not_found do
               Elasticsearch::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )