elasticsearch-api 6.1.0 → 6.2.0

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

@@ -47,8 +47,18 @@ module Elasticsearch
         #
         def put_settings(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          method = HTTP_PUT
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_settings'
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = arguments[:body]
 
-          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(:put_settings, [
             :ignore_indices,
             :ignore_unavailable,
             :include_defaults,
@@ -56,16 +66,7 @@ module Elasticsearch
             :expand_wildcards,
             :preserve_existing,
             :master_timeout,
-            :flat_settings
-          ]
-
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_settings'
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          body   = arguments[:body]
-
-          perform_request(method, path, params, body).body
-        end
+            :flat_settings ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/put_template.rb

@@ -24,16 +24,19 @@ module Elasticsearch
         def put_template(arguments={})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [ :create, :order, :timeout ]
-
           method = HTTP_PUT
           path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
 
-          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_template, [ :create, :order, :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/put_warmer.rb

@@ -40,24 +40,25 @@ module Elasticsearch
         def put_warmer(arguments={})
           raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
           raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
-
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards
-          ]
-
           method = HTTP_PUT
           path   = Utils.__pathify( Utils.__listify(arguments[:index]),
                                     Utils.__listify(arguments[:type]),
                                     '_warmer',
                                     Utils.__listify(arguments[:name]) )
-          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_warmer, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/recovery.rb

@@ -25,17 +25,21 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html
         #
         def recovery(arguments={})
-          valid_params = [
-            :detailed,
-            :active_only,
-            :human ]
           method = HTTP_GET
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_recovery'
-          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(:recovery, [
+            :detailed,
+            :active_only,
+            :human ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/refresh.rb

@@ -33,21 +33,23 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/
         #
         def refresh(arguments={})
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards
-          ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_refresh'
 
-          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(:refresh, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/rollover.rb

@@ -18,25 +18,25 @@ module Elasticsearch
         #
         def rollover(arguments={})
           raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
-
-          valid_params = [
-            :wait_for_active_shards,
-            :timeout,
-            :master_timeout,
-            :dry_run ]
-
           arguments = arguments.clone
-
           source = arguments.delete(:alias)
           target = arguments.delete(:new_index)
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__escape(source), '_rollover', Utils.__escape(target)
-          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(:rollover, [
+            :wait_for_active_shards,
+            :timeout,
+            :master_timeout,
+            :dry_run ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/segments.rb

@@ -24,22 +24,24 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
         #
         def segments(arguments={})
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :verbose
-          ]
-
           method = HTTP_GET
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_segments'
 
-          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(:segments, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :verbose ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/shard_stores.rb

@@ -15,19 +15,23 @@ module Elasticsearch
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html
         #
         def shard_stores(arguments={})
-          valid_params = [
-            :status,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :operation_threading ]
           method = 'GET'
           path   = Utils.__pathify Utils.__escape(arguments[:index]), "_shard_stores"
-          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(:shard_stores, [
+            :status,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :operation_threading ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/shrink.rb

@@ -19,26 +19,26 @@ module Elasticsearch
         def shrink(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
-
-          valid_params = [
-            :wait_for_active_shards,
-            :wait_for_no_relocating_shards,
-            :timeout,
-            :master_timeout
-          ]
-
           arguments = arguments.clone
-
           source = arguments.delete(:index)
           target = arguments.delete(:target)
 
           method = HTTP_PUT
           path   = Utils.__pathify(source, '_shrink', target)
-          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(:shrink, [
+            :wait_for_active_shards,
+            :wait_for_no_relocating_shards,
+            :timeout,
+            :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/snapshot_index.rb

@@ -22,21 +22,22 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
         #
         def snapshot_index(arguments={})
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards
-          ]
-
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_gateway/snapshot'
-
-          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(:snapshot_index, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/split.rb

@@ -18,17 +18,26 @@ module Elasticsearch
         def split(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
-          valid_params = [
-            :timeout,
-            :master_timeout,
-            :wait_for_active_shards ]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), '_split', Utils.__escape(arguments[:target])
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          arguments = arguments.clone
+          source = arguments.delete(:index)
+          target = arguments.delete(:target)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = Utils.__pathify Utils.__escape(source), '_split', Utils.__escape(target)
+          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 6.2.0
+        ParamsRegistry.register(:split, [
+            :copy_settings,
+            :timeout,
+            :master_timeout,
+            :wait_for_active_shards ].freeze)
       end
     end
   end

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

@@ -76,22 +76,23 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html
         #
         def stats(arguments={})
-          valid_parts = [
-            :docs,
-            :fielddata,
-            :filter_cache,
-            :flush,
-            :get,
-            :indexing,
-            :merge,
-            :metric,
-            :refresh,
-            :search,
-            :suggest,
-            :store,
-            :warmer ]
+          method = HTTP_GET
+          parts  = Utils.__extract_parts arguments, ParamsRegistry.get(:stats_parts)
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:stats_params)
+          params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
+          params[:groups] = Utils.__listify(params[:groups], :escape => false) if params[:groups]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
 
-          valid_params = [
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:stats_params, [
             :fields,
             :completion_fields,
             :fielddata_fields,
@@ -102,21 +103,25 @@ module Elasticsearch
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :include_segment_file_sizes ]
+            :include_segment_file_sizes ].freeze)
 
-          method = HTTP_GET
-
-          parts  = Utils.__extract_parts arguments, valid_parts
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
-          params[:groups] = Utils.__listify(params[:groups], :escape => false) if params[:groups]
-
-          body   = nil
-
-          perform_request(method, path, params, body).body
-        end
+        # Register this action with its valid parts when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:stats_parts, [
+            :docs,
+            :fielddata,
+            :filter_cache,
+            :flush,
+            :get,
+            :indexing,
+            :merge,
+            :metric,
+            :refresh,
+            :search,
+            :suggest,
+            :store,
+            :warmer ].freeze)
       end
     end
   end

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

@@ -34,18 +34,10 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-indices-status/
         #
         def status(arguments={})
-          valid_params = [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :recovery,
-            :snapshot ]
-
           method = HTTP_GET
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_status'
 
-          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)
@@ -54,6 +46,17 @@ 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(:status, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :recovery,
+            :snapshot ].freeze)
       end
     end
   end