elasticsearch-xpack 7.3.0 → 7.4.0

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

@@ -11,25 +11,29 @@ module Elasticsearch
           # Enable a user
           #
           # @option arguments [String] :username The username of the user to enable
-          # @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] :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)
           #
           # @see https://www.elastic.co/guide/en/x-pack/5.4/security-api-users.html
           #
           def enable_user(arguments={})
-            valid_params = [
-              :username,
-              :refresh ]
-
             arguments = arguments.clone
             username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/security/user/#{username}/_enable"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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(:enable_user, [ :username,
+                                                  :refresh ].freeze)
         end
       end
     end

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

@@ -21,18 +21,20 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
           #
           def get_api_key(arguments={})
-
-            valid_params = [ :id,
-                             :name,
-                             :username,
-                             :realm_name ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_security/api_key"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             perform_request(method, path, params).body
           end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 7.4.0
+          ParamsRegistry.register(:get_api_key, [ :id,
+                                                  :name,
+                                                  :username,
+                                                  :realm_name ].freeze)
         end
       end
     end

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

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module XPack
+    module API
+      module Security
+        module Actions
+          module ParamsRegistry
+
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,16 +16,18 @@ module Elasticsearch
           #
           def put_privileges(arguments={})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-            valid_params = [ :refresh ]
-
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/security/privilege"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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_privileges, [ :refresh ].freeze)
         end
       end
     end

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

@@ -19,16 +19,18 @@ module Elasticsearch
           def put_role(arguments={})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-            valid_params = [ :refresh ]
-
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/security/role/#{arguments[:name]}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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_role, [ :refresh ].freeze)
         end
       end
     end

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

@@ -12,27 +12,31 @@ module Elasticsearch
           #
           # @option arguments [String] :name Role-mapping name (*Required*)
           # @option arguments [Hash] :body The role to add (*Required*)
-          # @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] :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)
           #
           # @see https://www.elastic.co/guide/en/x-pack/master/security-api-role-mapping.html#security-api-put-role-mapping
           #
           def put_role_mapping(arguments={})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-            valid_params = [
-              :name,
-              :refresh ]
-
             arguments = arguments.clone
             name = arguments.delete(:name)
 
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/security/role_mapping/#{name}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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_role_mapping, [ :name,
+                                                       :refresh ].freeze)
         end
       end
     end

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

@@ -19,19 +19,21 @@ module Elasticsearch
           def put_user(arguments={})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-            valid_params = [ :refresh ]
-
             arguments = arguments.clone
             username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
             path   = Elasticsearch::API::Utils.__pathify "_xpack/security/user", username
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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
       end
     end

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

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module XPack
+    module API
+      module SQL
+        module Actions
+          module ParamsRegistry
+
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,15 +17,18 @@ module Elasticsearch
           #
           def query(arguments={})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-            valid_params = [
-              :format ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/sql"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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
       end
     end

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

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module XPack
+    module API
+      module SSL
+        module Actions
+          module ParamsRegistry
+
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,14 +13,19 @@ module Elasticsearch
         #
         #
         def usage(arguments={})
-          valid_params = [ :master_timeout ]
           method = Elasticsearch::API::HTTP_GET
           path   = "_xpack/usage"
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           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
   end

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

@@ -18,10 +18,6 @@ module Elasticsearch
           #
           def ack_watch(arguments={})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
-
-            valid_params = [
-              :master_timeout ]
-
             arguments = arguments.clone
             watch_id  = arguments.delete(:watch_id)
             action_id  = arguments.delete(:action_id)
@@ -31,11 +27,16 @@ module Elasticsearch
             path   = "_xpack/watcher/watch/#{watch_id}/_ack"
             path << "/#{action_id}" if action_id
 
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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

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

@@ -17,18 +17,21 @@ module Elasticsearch
           #
           def activate_watch(arguments={})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
-            valid_params = [ :master_timeout ]
-
             arguments = arguments.clone
             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, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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

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

@@ -17,18 +17,21 @@ module Elasticsearch
           #
           def deactivate_watch(arguments={})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
-            valid_params = [ :master_timeout ]
-
             arguments = arguments.clone
             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, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             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