elasticsearch-api 6.1.0 → 6.2.0

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -39,7 +39,19 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html
         #
         def thread_pool(arguments={})
-          valid_params = [
+          method = HTTP_GET
+          path   = "_cat/thread_pool"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:thread_pool, [
             :full_id,
             :size,
             :local,
@@ -48,16 +60,7 @@ module Elasticsearch
             :h,
             :help,
             :v,
-            :s ]
-
-          method = HTTP_GET
-          path   = "_cat/thread_pool"
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
-
-          perform_request(method, path, params, body).body
-        end
+            :s ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -13,16 +13,20 @@ module Elasticsearch
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
         #
         def allocation_explain(arguments={})
-          valid_params = [
-            :include_yes_decisions,
-            :include_disk_info ]
           method = 'GET'
           path   = "_cluster/allocation/explain"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:allocation_explain, [
+            :include_yes_decisions,
+            :include_disk_info ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -16,18 +16,20 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
         def get_settings(arguments={})
-          valid_params = [
-            :flat_settings,
-            :include_defaults
-          ]
-
           method = HTTP_GET
           path   = "_cluster/settings"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:get_settings, [
+            :flat_settings,
+            :include_defaults ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/health.rb

@@ -38,8 +38,19 @@ module Elasticsearch
         def health(arguments={})
           arguments = arguments.clone
           index     = arguments.delete(:index)
+          method = HTTP_GET
+          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body = nil
 
-          valid_params = [
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:health, [
             :level,
             :local,
             :master_timeout,
@@ -50,16 +61,7 @@ module Elasticsearch
             :wait_for_no_relocating_shards,
             :wait_for_no_initializing_shards,
             :wait_for_status,
-            :wait_for_events ]
-
-          method = HTTP_GET
-          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          body = nil
-
-          perform_request(method, path, params, body).body
-        end
+            :wait_for_events ].freeze)
       end
     end
   end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+        module ParamsRegistry
+
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.2.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 6.2.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 6.2.0
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb

@@ -17,16 +17,20 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-pending.html
         #
         def pending_tasks(arguments={})
-          valid_params = [
-            :local,
-            :master_timeout ]
           method = HTTP_GET
           path   = "_cluster/pending_tasks"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:pending_tasks, [
+            :local,
+            :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -15,15 +15,18 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
         def put_settings(arguments={})
-          valid_params = [ :flat_settings ]
-
           method = HTTP_PUT
           path   = "_cluster/settings"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:put_settings, [ :flat_settings ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -32,16 +32,25 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
         #
         def reroute(arguments={})
-          valid_params = [ :dry_run, :explain, :metric, :master_timeout, :retry_failed, :timeout ]
-
           method = HTTP_POST
           path   = "_cluster/reroute"
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:reroute, [
+            :dry_run,
+            :explain,
+            :metric,
+            :master_timeout,
+            :retry_failed,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -31,25 +31,12 @@ module Elasticsearch
           arguments = arguments.clone
           index     = arguments.delete(:index)
           metric    = arguments.delete(:metric)
-
-          valid_params = [
-            :metric,
-            :index_templates,
-            :local,
-            :master_timeout,
-            :flat_settings,
-            :allow_no_indices,
-            :expand_wildcards,
-            :ignore_unavailable ]
-
           method = HTTP_GET
-          path   = "_cluster/state"
-
           path   = Utils.__pathify '_cluster/state',
                                    Utils.__listify(metric),
                                    Utils.__listify(index)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           [:index_templates].each do |key|
             params[key] = Utils.__listify(params[key]) if params[key]
@@ -59,6 +46,19 @@ module Elasticsearch
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:state, [
+            :metric,
+            :index_templates,
+            :local,
+            :master_timeout,
+            :flat_settings,
+            :allow_no_indices,
+            :expand_wildcards,
+            :ignore_unavailable ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/stats.rb

@@ -13,17 +13,21 @@ module Elasticsearch
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
         #
         def stats(arguments={})
-          valid_params = [
-            :flat_settings,
-            :human,
-            :timeout ]
           method = 'GET'
           path   = "_cluster/stats"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = 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 6.2.0
+        ParamsRegistry.register(:stats, [
+            :flat_settings,
+            :human,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/count.rb

@@ -48,7 +48,19 @@ module Elasticsearch
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
       #
       def count(arguments={})
-        valid_params = [
+        method = HTTP_GET
+        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
+
+        params = 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 6.2.0
+      ParamsRegistry.register(:count, [
           :ignore_unavailable,
           :allow_no_indices,
           :expand_wildcards,
@@ -62,16 +74,7 @@ module Elasticsearch
           :df,
           :lenient,
           :lowercase_expanded_terms,
-          :terminate_after ]
-
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body]
-
-        perform_request(method, path, params, body).body
-      end
+          :terminate_after ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/count_percolate.rb

@@ -51,16 +51,6 @@ module Elasticsearch
       def count_percolate(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
-        valid_params = [
-          :routing,
-          :preference,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :percolate_index,
-          :percolate_type,
-          :version,
-          :version_type ]
 
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
@@ -68,11 +58,25 @@ module Elasticsearch
                                  arguments[:id],
                                  '_percolate/count'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = 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 6.2.0
+      ParamsRegistry.register(:count_percolate, [
+          :routing,
+          :preference,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :percolate_index,
+          :percolate_type,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -33,22 +33,12 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
 
-        valid_params = [
-          :consistency,
-          :parent,
-          :refresh,
-          :replication,
-          :routing,
-          :timeout,
-          :version,
-          :version_type ]
-
         method = HTTP_DELETE
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  Utils.__escape(arguments[:id])
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = nil
 
         if Array(arguments[:ignore]).include?(404)
@@ -57,6 +47,19 @@ module Elasticsearch
           perform_request(method, path, params, body).body
         end
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:delete, [
+          :consistency,
+          :parent,
+          :refresh,
+          :replication,
+          :routing,
+          :timeout,
+          :version,
+          :version_type ].freeze)
     end
   end
 end