elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,35 +7,41 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Update or create a user for the native realm
           #
-          # @option arguments [String] :username The username of the User (*Required*)
+          # @option arguments [String] :username The username of the User
+          # @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 [Hash] :body The user to add (*Required*)
-          # @option arguments [Boolean] :refresh Refresh the index after performing the operation
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-users.html#security-api-put-user
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html
           #
-          def put_user(arguments={})
-            raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+          def put_user(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
             arguments = arguments.clone
-            username = arguments.delete(:username)
+
+            _username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/user", username
+            path   = "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}"
             params = Elasticsearch::API::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 7.4.0
-          ParamsRegistry.register(:put_user, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:put_user, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb

@@ -7,23 +7,25 @@ module Elasticsearch
     module API
       module SQL
         module Actions
-
           # TODO: Description
-          #
+
           # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
           #
           # @see Clear SQL cursor
           #
-          def clear_cursor(arguments={})
+          def clear_cursor(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/sql/close"
+            path   = "_sql/close"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
+      end
       end
     end
   end

data/lib/elasticsearch/xpack/api/actions/sql/params_registry.rb

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

data/lib/elasticsearch/xpack/api/actions/sql/query.rb

@@ -7,29 +7,35 @@ module Elasticsearch
     module API
       module SQL
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*)
           # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+
+          # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*)
           #
           # @see Execute SQL
           #
-          def query(arguments={})
+          def query(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/sql"
+            path   = "_sql"
             params = Elasticsearch::API::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 7.4.0
-          ParamsRegistry.register(:query, [ :format ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:query, [
+            :format
+          ].freeze)
+      end
       end
     end
   end

data/lib/elasticsearch/xpack/api/actions/sql/translate.rb

@@ -7,23 +7,25 @@ module Elasticsearch
     module API
       module SQL
         module Actions
-
           # TODO: Description
-          #
+
           # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*)
           #
           # @see Translate SQL into Elasticsearch queries
           #
-          def translate(arguments={})
+          def translate(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/sql/translate"
+            path   = "_sql/translate"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
+      end
       end
     end
   end

data/lib/elasticsearch/xpack/api/actions/ssl/certificates.rb

@@ -7,16 +7,22 @@ module Elasticsearch
     module API
       module SSL
         module Actions
+          # TODO: Description
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html
+          #
+          def certificates(arguments = {})
+            arguments = arguments.clone
 
-          def certificates(arguments={})
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ssl/certificates"
+            path   = "_ssl/certificates"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
+      end
       end
     end
   end

data/lib/elasticsearch/xpack/api/actions/ssl/params_registry.rb

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

data/lib/elasticsearch/xpack/api/actions/usage.rb

@@ -6,27 +6,32 @@ module Elasticsearch
   module XPack
     module API
       module Actions
+        # TODO: Description
 
-        # Retrieve information about X-Pack features usage
         #
-        # @option arguments [Duration] :master_timeout Specify timeout for watch write operation
+        # @option arguments [Time] :master_timeout Specify timeout for watch write operation
+
         #
+        # @see Retrieve information about xpack features usage
         #
-        def usage(arguments={})
+        def usage(arguments = {})
+          arguments = arguments.clone
+
           method = Elasticsearch::API::HTTP_GET
           path   = "_xpack/usage"
           params = Elasticsearch::API::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 7.4.0
-        ParamsRegistry.register(:usage, [ :master_timeout ].freeze)
-      end
-    end
+        # @since 6.2.0
+        ParamsRegistry.register(:usage, [
+          :master_timeout
+        ].freeze)
   end
+      end
+end
 end

data/lib/elasticsearch/xpack/api/actions/watcher/ack_watch.rb

@@ -7,38 +7,37 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
+          # TODO: Description
 
-          # Acknowledge watch actions to throttle their executions
           #
-          # @option arguments [String] :watch_id Watch ID (*Required*)
-          # @option arguments [List] :action_id A comma-separated list of the action ids to be acked (default: all)
-          # @option arguments [Duration] :master_timeout Specify timeout for watch write operation
+          # @option arguments [String] :watch_id Watch ID
+          # @option arguments [List] :action_id A comma-separated list of the action ids to be acked
+
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/watcher-api-ack-watch.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
           #
-          def ack_watch(arguments={})
+          def ack_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
+
             arguments = arguments.clone
-            watch_id  = arguments.delete(:watch_id)
-            action_id  = arguments.delete(:action_id)
 
-            method = Elasticsearch::API::HTTP_PUT
+            _watch_id = arguments.delete(:watch_id)
 
-            path   = "_xpack/watcher/watch/#{watch_id}/_ack"
-            path << "/#{action_id}" if action_id
+            _action_id = arguments.delete(:action_id)
 
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
+            method = Elasticsearch::API::HTTP_PUT
+            path   = if _watch_id && _action_id
+                       "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_watch_id)}/_ack/#{Elasticsearch::API::Utils.__listify(_action_id)}"
+                     else
+                       "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_watch_id)}/_ack"
+  end
+            params = {}
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          # @since 7.4.0
-          ParamsRegistry.register(:ack_watch, [ :master_timeout ].freeze)
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/watcher/activate_watch.rb

@@ -7,33 +7,30 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
+          # TODO: Description
 
-          # Activate a currently inactive watch
           #
-          # @option arguments [String] :watch_id Watch ID (*Required*)
-          # @option arguments [Duration] :master_timeout Specify timeout for watch write operation
+          # @option arguments [String] :watch_id Watch ID
+
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/watcher-api-activate-watch.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html
           #
-          def activate_watch(arguments={})
+          def activate_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
+
             arguments = arguments.clone
-            watch_id  = arguments.delete(:watch_id)
+
+            _watch_id = arguments.delete(:watch_id)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/watcher/watch/#{watch_id}/_activate"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
+            path   = "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_watch_id)}/_activate"
+            params = {}
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          # @since 7.4.0
-          ParamsRegistry.register(:activate_watch, [ :master_timeout ].freeze)
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/watcher/deactivate_watch.rb

@@ -7,33 +7,30 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
+          # TODO: Description
 
-          # Deactivate a currently active watch
           #
-          # @option arguments [String] :watch_id Watch ID (*Required*)
-          # @option arguments [Duration] :master_timeout Specify timeout for watch write operation
+          # @option arguments [String] :watch_id Watch ID
+
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/watcher-api-deactivate-watch.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html
           #
-          def deactivate_watch(arguments={})
+          def deactivate_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
+
             arguments = arguments.clone
-            watch_id  = arguments.delete(:watch_id)
+
+            _watch_id = arguments.delete(:watch_id)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/watcher/watch/#{watch_id}/_deactivate"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
+            path   = "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_watch_id)}/_deactivate"
+            params = {}
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          # @since 7.4.0
-          ParamsRegistry.register(:deactivate_watch, [ :master_timeout ].freeze)
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/watcher/delete_watch.rb

@@ -7,36 +7,34 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
+          # TODO: Description
 
-          # Remove a watch
           #
-          # @option arguments [String] :id Watch ID (*Required*)
-          # @option arguments [Duration] :master_timeout Specify timeout for watch write operation
-          # @option arguments [Boolean] :force Specify if this request should be forced and ignore locks
+          # @option arguments [String] :id Watch ID
+
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/appendix-api-delete-watch.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
           #
-          def delete_watch(arguments={})
+          def delete_watch(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/watcher/watch/#{arguments[:id]}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
+            path   = "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
 
+            body = nil
             if Array(arguments[:ignore]).include?(404)
               Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
             else
               perform_request(method, path, params, body).body
             end
           end
-
-          # Register this action with its valid params when the module is loaded.
-          #
-          # @since 7.4.0
-          ParamsRegistry.register(:delete_watch, [ :master_timeout,
-                                                   :force ].freeze)
-        end
       end
     end
+    end
   end
 end