elasticsearch-xpack 7.3.0 → 7.4.0

data/lib/elasticsearch/xpack/api/actions/migration/upgrade.rb

@@ -17,17 +17,18 @@ module Elasticsearch
           #
           def upgrade(arguments={})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
-            valid_params = [
-              :wait_for_completion ]
-
             method = Elasticsearch::API::HTTP_POST
             path   = Elasticsearch::API::Utils.__pathify "_xpack/migration/upgrade", arguments[:index]
-            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(:upgrade, [ :wait_for_completion ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb

@@ -20,20 +20,13 @@ module Elasticsearch
           #
           def bulk(arguments={})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-            valid_params = [
-              :system_id,
-              :system_api_version,
-              :system_version,
-              :interval ]
-
             arguments = arguments.clone
             type = arguments.delete(:type)
             body = arguments.delete(:body)
 
             method = Elasticsearch::API::HTTP_POST
             path   = Elasticsearch::API::Utils.__pathify '_xpack/monitoring', type, '_bulk'
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             if body.is_a? Array
               payload = Elasticsearch::API::Utils.__bulkify(body)
@@ -43,6 +36,14 @@ module Elasticsearch
 
             perform_request(method, path, params, payload).body
           end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 7.4.0
+          ParamsRegistry.register(:bulk, [ :system_id,
+                                           :system_api_version,
+                                           :system_version,
+                                           :interval ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/monitoring/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 Monitoring
+        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/params_registry.rb

@@ -0,0 +1,48 @@
+# 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 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

data/lib/elasticsearch/xpack/api/actions/rollup/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 Rollup
+        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/rollup/rollup_search.rb

@@ -20,15 +20,19 @@ module Elasticsearch
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
-            valid_params = [ :typed_keys, :rest_total_hits_as_int ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "#{arguments[:index]}/_rollup_search"
-            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(:rollup_search, [ :typed_keys,
+                                                    :rest_total_hits_as_int ].freeze)
         end
       end
     end

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

@@ -13,7 +13,6 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/x-pack/current/security-api-authenticate.html
           #
           def authenticate(arguments={})
-            valid_params = []
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/security/_authenticate"
             params = {}

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

@@ -18,19 +18,21 @@ module Elasticsearch
           #
           def change_password(arguments={})
             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, "/_password"
-            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(:change_password, [ :refresh ].freeze)
         end
       end
     end

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

@@ -17,19 +17,21 @@ module Elasticsearch
           #
           def clear_cached_realms(arguments={})
             raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
-
-            valid_params = [ :usernames ]
-
             arguments = arguments.clone
             realms = arguments.delete(:realms)
 
             method = Elasticsearch::API::HTTP_POST
             path   = Elasticsearch::API::Utils.__pathify "_xpack/security/realm/", Elasticsearch::API::Utils.__listify(realms), "_clear_cache"
-            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(:clear_cached_realms, [ :usernames ].freeze)
         end
       end
     end

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

@@ -20,15 +20,17 @@ module Elasticsearch
           #
           def create_api_key(arguments={})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-            valid_params = [ :refresh ]
-
             method = Elasticsearch::API::HTTP_PUT
             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, arguments[:body]).body
           end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 7.4.0
+          ParamsRegistry.register(:create_api_key, [ :refresh ].freeze)
         end
       end
     end

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

@@ -15,15 +15,18 @@ module Elasticsearch
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
 
-            valid_params = [ :refresh ]
-
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_xpack/security/privilege/#{arguments.delete(:application)}/#{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   = 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(:delete_privileges, [ :refresh ].freeze)
         end
       end
     end

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

@@ -17,12 +17,9 @@ module Elasticsearch
           #
           def delete_role(arguments={})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-
-            valid_params = [ :refresh ]
-
             method = Elasticsearch::API::HTTP_DELETE
             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   = nil
 
             if Array(arguments[:ignore]).include?(404)
@@ -31,6 +28,11 @@ module Elasticsearch
               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_role, [ :refresh ].freeze)
         end
       end
     end

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

@@ -17,20 +17,22 @@ module Elasticsearch
           #
           def delete_role_mapping(arguments={})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-            valid_params = [
-              :name,
-              :refresh ]
-
             arguments = arguments.clone
             name = arguments.delete(:name)
 
             method = Elasticsearch::API::HTTP_DELETE
             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   = 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(:delete_role_mapping, [ :name,
+                                                          :refresh ].freeze)
         end
       end
     end

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

@@ -16,16 +16,12 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/x-pack/current/security-api-users.html#security-api-delete-user
           #
           def delete_user(arguments={})
-            valid_params = [
-              :username,
-              :refresh ]
-
             arguments = arguments.clone
             username  = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_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   = nil
 
             if Array(arguments[:ignore]).include?(404)
@@ -34,6 +30,12 @@ module Elasticsearch
               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_user, [ :username,
+                                                  :refresh ].freeze)
         end
       end
     end

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

@@ -11,25 +11,29 @@ module Elasticsearch
           # Disable a user
           #
           # @option arguments [String] :username The username of the user to disable
-          # @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 disable_user(arguments={})
-            valid_params = [
-              :username,
-              :refresh ]
-
             arguments = arguments.clone
             username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/security/user/#{username}/_disable"
-            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(:disable_user, [ :username,
+                                                   :refresh ].freeze)
         end
       end
     end