elasticsearch-api 6.1.0 → 6.2.0

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

@@ -13,8 +13,8 @@ module Elasticsearch
       def put_template(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_PUT
-        path   = "_search/template/#{arguments[:id]}"
+        method = HTTP_POST
+        path   = "_scripts/#{arguments[:id]}"
         params = {}
         body   = arguments[:body]
 

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

@@ -53,20 +53,24 @@ module Elasticsearch
       #
       def reindex(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        valid_params = [
-          :refresh,
-          :timeout,
-          :consistency,
-          :wait_for_completion,
-          :requests_per_second,
-          :slices ]
         method = 'POST'
         path   = "_reindex"
-        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(:reindex, [
+          :refresh,
+          :timeout,
+          :consistency,
+          :wait_for_completion,
+          :requests_per_second,
+          :slices ].freeze)
     end
   end
 end

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

@@ -10,16 +10,19 @@ module Elasticsearch
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
       #
       def render_search_template(arguments={})
-        valid_params = [
-          :id
-        ]
         method = 'GET'
         path   = "_render/template"
-        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(:render_search_template, [
+          :id ].freeze)
     end
   end
 end

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

@@ -51,15 +51,19 @@ module Elasticsearch
       def scroll(arguments={})
         method = HTTP_GET
         path   = "_search/scroll"
-        valid_params = [
-          :scroll,
-          :scroll_id ]
-
-        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(:scroll, [
+          :scroll,
+          :scroll_id,
+          :rest_total_hits_as_int ].freeze)
     end
   end
 end

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

@@ -126,8 +126,26 @@ module Elasticsearch
       #
       def search(arguments={})
         arguments[:index] = UNDERSCORE_ALL if ! arguments[:index] && arguments[:type]
+        method = HTTP_GET
+        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
+
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body   = arguments[:body]
+
+        params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
+        params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
 
-        valid_params = [
+        # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
+        params[:filter_path] =  defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
+
+        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(:search, [
           :analyzer,
           :analyze_wildcard,
           :default_operator,
@@ -156,7 +174,9 @@ module Elasticsearch
           :source,
           :_source,
           :_source_include,
+          :_source_includes,
           :_source_exclude,
+          :_source_excludes,
           :stored_fields,
           :stats,
           :suggest_field,
@@ -169,23 +189,9 @@ module Elasticsearch
           :version,
           :batched_reduce_size,
           :max_concurrent_shard_requests,
-          :pre_filter_shard_size ]
-
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-
-        body   = arguments[:body]
-
-        params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
-        params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
-
-        # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
-        params[:filter_path] =  defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
-
-        perform_request(method, path, params, body).body
-      end
+          :pre_filter_shard_size,
+          :rest_total_hits_as_int,
+          :ignore_throttled ].freeze)
     end
   end
 end

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

@@ -33,7 +33,18 @@ module Elasticsearch
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html
       #
       def search_exists(arguments={})
-        valid_params = [
+        method = 'POST'
+        path   = "_search/exists"
+        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(:search_exists, [
           :ignore_unavailable,
           :allow_no_indices,
           :expand_wildcards,
@@ -46,14 +57,7 @@ module Elasticsearch
           :default_operator,
           :df,
           :lenient,
-          :lowercase_expanded_terms ]
-        method = 'POST'
-        path   = "_search/exists"
-        params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body]
-
-        perform_request(method, path, params, body).body
-      end
+          :lowercase_expanded_terms ].freeze)
     end
   end
 end

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

@@ -22,20 +22,24 @@ module Elasticsearch
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html
       #
       def search_shards(arguments={})
-        valid_params = [
-          :preference,
-          :routing,
-          :local,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ]
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search_shards' )
-        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(:search_shards, [
+          :preference,
+          :routing,
+          :local,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ].freeze)
     end
   end
 end

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

@@ -41,21 +41,25 @@ module Elasticsearch
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
       #
       def search_template(arguments={})
-        valid_params = [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :preference,
-          :routing,
-          :scroll,
-          :search_type ]
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search/template' )
-        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(:search_template, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :preference,
+          :routing,
+          :scroll,
+          :search_type ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/create.rb

@@ -27,21 +27,24 @@ module Elasticsearch
         def create(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          valid_params = [
-            :master_timeout,
-            :wait_for_completion ]
-
           repository = arguments.delete(:repository)
           snapshot   = arguments.delete(:snapshot)
 
           method = HTTP_PUT
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot) )
 
-          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(:create, [
+            :master_timeout,
+            :wait_for_completion ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot/create_repository.rb

@@ -23,21 +23,24 @@ module Elasticsearch
         def create_repository(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'body' missing"       unless arguments[:body]
-          valid_params = [
-            :repository,
-            :master_timeout,
-            :timeout ]
-
           repository = arguments.delete(:repository)
 
           method = HTTP_PUT
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
 
-          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(:create_repository, [
+            :repository,
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

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

@@ -21,17 +21,13 @@ module Elasticsearch
         def delete(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-
-          valid_params = [
-            :master_timeout ]
-
           repository = arguments.delete(:repository)
           snapshot   = arguments.delete(:snapshot)
 
           method = HTTP_DELETE
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
 
-          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)
@@ -40,6 +36,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 6.2.0
+        ParamsRegistry.register(:delete, [ :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb

@@ -18,17 +18,12 @@ module Elasticsearch
         #
         def delete_repository(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          valid_params = [
-            :master_timeout,
-            :timeout ]
-
           repository = arguments.delete(:repository)
 
           method = HTTP_DELETE
           path   = Utils.__pathify( '_snapshot', Utils.__listify(repository) )
 
-          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)
@@ -37,6 +32,13 @@ 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_repository, [
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot/get.rb

@@ -28,19 +28,13 @@ module Elasticsearch
         def get(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-
-          valid_params = [
-            :ignore_unavailable,
-            :master_timeout,
-            :verbose ]
-
           repository = arguments.delete(:repository)
           snapshot   = arguments.delete(:snapshot)
 
           method = HTTP_GET
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
 
-          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)
@@ -49,6 +43,14 @@ 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(:get, [
+            :ignore_unavailable,
+            :master_timeout,
+            :verbose ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot/get_repository.rb

@@ -23,16 +23,11 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
         def get_repository(arguments={})
-          valid_params = [
-            :master_timeout,
-            :local ]
-
           repository = arguments.delete(:repository)
-
           method = HTTP_GET
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
 
-          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)
@@ -41,6 +36,13 @@ 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(:get_repository, [
+            :master_timeout,
+            :local ].freeze)
       end
     end
   end