elasticsearch-api 7.3.0 → 7.5.0

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

@@ -6,47 +6,42 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Create a repository for storing snapshots
-        #
-        # @example Create a repository at `/tmp/backup`
+        # Creates a repository.
         #
-        #     client.snapshot.create_repository repository: 'my-backups',
-        #                                       body: {
-        #                                         type: 'fs',
-        #                                         settings: { location: '/tmp/backup', compress: true  }
-        #                                       }
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [Hash] :body The repository definition (*Required*)
+        # @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 [Hash] :body The repository definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html#_repositories
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def create_repository(arguments={})
+        def create_repository(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'body' missing"       unless arguments[:body]
-          repository = arguments.delete(:repository)
 
-          method = HTTP_PUT
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+          arguments = arguments.clone
 
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_snapshot/#{Utils.__listify(_repository)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:create_repository, [
-            :master_timeout,
-            :timeout,
-            :verify ].freeze)
+          :master_timeout,
+          :timeout,
+          :verify
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,34 +6,30 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Delete a snapshot from the repository
-        #
-        # @note Will also abort a currently running snapshot.
-        #
-        # @example Delete the `snapshot-1` snapshot
-        #
-        #     client.snapshot.delete repository: 'my-backups', snapshot: 'snapshot-1'
+        # Deletes a snapshot.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [String] :snapshot A snapshot name (*Required*)
+        # @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 [Number,List] :ignore The list of HTTP errors to ignore
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def delete(arguments={})
+        def delete(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          arguments = arguments.clone
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _repository = arguments.delete(:repository)
 
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
             Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
           else
@@ -43,9 +39,11 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
-        ParamsRegistry.register(:delete, [ :master_timeout ].freeze)
+        # @since 6.2.0
+        ParamsRegistry.register(:delete, [
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,30 +6,27 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Delete a specific repository or repositories
-        #
-        # @example Delete the `my-backups` repository
-        #
-        #     client.snapshot.delete_repository repository: 'my-backups'
+        # Deletes a repository.
         #
-        # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
+        # @option arguments [List] :repository A comma-separated list of repository names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def delete_repository(arguments={})
+        def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          repository = arguments.delete(:repository)
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__listify(repository) )
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_snapshot/#{Utils.__listify(_repository)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
             Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
           else
@@ -39,11 +36,12 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:delete_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,42 +6,32 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Return information about specific (or all) snapshots
-        #
-        # @example Return information about the `snapshot-2` snapshot
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: 'snapshot-2'
-        #
-        # @example Return information about multiple snapshots
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: ['snapshot-2', 'snapshot-3']
-        #
-        # @example Return information about all snapshots in the repository
+        # Returns information about a snapshot.
         #
-        #     client.snapshot.get repository: 'my-backup', snapshot: '_all'
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
-        #   false which means a SnapshotMissingException is thrown
+        # @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] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def get(arguments={})
+        def get(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          arguments = arguments.clone
 
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _repository = arguments.delete(:repository)
 
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
             Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
           else
@@ -51,12 +41,13 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:get, [
-            :ignore_unavailable,
-            :master_timeout,
-            :verbose ].freeze)
+          :master_timeout,
+          :ignore_unavailable,
+          :verbose
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,34 +6,29 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Get information about snapshot repositories or a specific repository
-        #
-        # @example Get all repositories
-        #
-        #     client.snapshot.get_repository
-        #
-        # @example Get a specific repository
-        #
-        #     client.snapshot.get_repository repository: 'my-backups'
+        # Returns information about a repository.
         #
-        # @option arguments [List] :repository A comma-separated list of repository names. Leave blank or use `_all`
-        #                                      to get a list of repositories
+        # @option arguments [List] :repository A comma-separated list of repository names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def get_repository(arguments={})
-          repository = arguments.delete(:repository)
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+        def get_repository(arguments = {})
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository
+                     "_snapshot/#{Utils.__listify(_repository)}"
+                   else
+                     "_snapshot"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
             Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
           else
@@ -43,11 +38,12 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:get_repository, [
-            :master_timeout,
-            :local ].freeze)
+          :master_timeout,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module Snapshot
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.

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

@@ -6,54 +6,43 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Restore the state from a snapshot
-        #
-        # @example Restore from the `snapshot-1` snapshot
-        #
-        #     client.snapshot.restore repository: 'my-backups', snapshot: 'snapshot-1'
-        #
-        # @example Restore a specific index under a different name
-        #
-        #     client.snapshot.restore repository: 'my-backups',
-        #                             snapshot: 'snapshot-1',
-        #                             body: {
-        #                               rename_pattern: "^(.*)$",
-        #                               rename_replacement: "restored_$1"
-        #                             }
-        #
-        # @note You cannot restore into an open index, you have to {Indices::Actions#close} it first
+        # Restores a snapshot.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [String] :snapshot A snapshot name (*Required*)
-        # @option arguments [Hash] :body Details of what to restore
+        # @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 [Hash] :body Details of what to restore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def restore(arguments={})
+        def restore(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
 
-          method = HTTP_POST
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_restore' )
+          arguments = arguments.clone
 
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:restore, [
-            :master_timeout,
-            :wait_for_completion ].freeze)
+          :master_timeout,
+          :wait_for_completion
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,36 +6,34 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Return information about a running snapshot
-        #
-        # @example Return information about all currently running snapshots
-        #
-        #     client.snapshot.status repository: 'my-backups', human: true
-        #
-        # @example Return information about a specific snapshot
-        #
-        #     client.snapshot.status repository: 'my-backups', human: true
+        # Returns information about the status of a snapshot.
         #
         # @option arguments [String] :repository A repository name
         # @option arguments [List] :snapshot A comma-separated list of snapshot names
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
-        #   false which means a SnapshotMissingException is thrown
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot_status
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def status(arguments={})
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+        def status(arguments = {})
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_GET
+          _snapshot = arguments.delete(:snapshot)
 
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_status')
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _repository && _snapshot
+                     "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_status"
+                   elsif _repository
+                     "_snapshot/#{Utils.__listify(_repository)}/_status"
+                   else
+                     "_snapshot/_status"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
             Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
           else
@@ -45,11 +43,12 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:status, [
-            :ignore_unavailable,
-            :master_timeout ].freeze)
+          :master_timeout,
+          :ignore_unavailable
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,33 +6,38 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Explicitly perform the verification of a repository
+        # Verifies a repository.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
+        # @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
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def verify_repository(arguments={})
+        def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          repository = arguments.delete(:repository)
-          method = HTTP_POST
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), '_verify' )
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:verify_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

data/lib/elasticsearch/api/actions/tasks/cancel.rb

@@ -6,36 +6,42 @@ module Elasticsearch
   module API
     module Tasks
       module Actions
-
-        # Cancel a specific task
+        # Cancels a task, if it can be cancelled through an API.
         #
         # @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [List] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
         # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-cancel.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/tasks.html
         #
-        def cancel(arguments={})
+        def cancel(arguments = {})
           arguments = arguments.clone
-          task_id = arguments.delete(:task_id)
 
-          method = 'POST'
-          path   = Utils.__pathify( '_tasks', Utils.__escape(task_id), '_cancel' )
+          _task_id = arguments.delete(:task_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _task_id
+                     "_tasks/#{Utils.__listify(_task_id)}/_cancel"
+                   else
+                     "_tasks/_cancel"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:cancel, [
-            :nodes,
-            :actions,
-            :parent_task_id ].freeze)
+          :nodes,
+          :actions,
+          :parent_task_id
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,33 +6,36 @@ module Elasticsearch
   module API
     module Tasks
       module Actions
-
-        # Return information about a specific task
+        # Returns information about a task.
         #
-        # @option arguments [String] :task_id Return the task with specified id (node_id:task_number) (*Required*)
+        # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/tasks.html
         #
-        def get(arguments={})
+        def get(arguments = {})
           arguments = arguments.clone
-          task_id = arguments.delete(:task_id)
-          method = HTTP_GET
-          path   = Utils.__pathify '_tasks', Utils.__escape(task_id)
+
+          _task_id = arguments.delete(:task_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_tasks/#{Utils.__listify(_task_id)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:get, [
-            :wait_for_completion,
-            :timeout ].freeze)
+          :wait_for_completion,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end