elasticsearch-api 6.1.0 → 6.2.0

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

@@ -55,8 +55,21 @@ module Elasticsearch
       #
       def delete_by_query(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        method = HTTP_POST
+        path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                 Utils.__listify(arguments[:type]),
+                                 '/_delete_by_query'
+
+        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(:delete_by_query, [
           :analyzer,
           :analyze_wildcard,
           :default_operator,
@@ -77,7 +90,9 @@ module Elasticsearch
           :sort,
           :_source,
           :_source_exclude,
+          :_source_excludes,
           :_source_include,
+          :_source_includes,
           :terminate_after,
           :stats,
           :version,
@@ -88,18 +103,7 @@ module Elasticsearch
           :scroll_size,
           :wait_for_completion,
           :requests_per_second,
-          :slices ]
-
-        method = HTTP_POST
-        path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                 Utils.__listify(arguments[:type]),
-                                 '/_delete_by_query'
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body]
-
-        perform_request(method, path, params, body).body
-      end
+          :slices ].freeze)
     end
   end
 end

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

@@ -5,7 +5,7 @@ module Elasticsearch
       # Remove an indexed script from Elasticsearch
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language (*Required*)
+      # @option arguments [String] :lang Script language
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
@@ -13,19 +13,20 @@ module Elasticsearch
       #
       def delete_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
-        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
-
-        valid_params = [
-          :version,
-          :version_type ]
-
         method = HTTP_DELETE
-        path   = "_scripts/#{arguments.delete(:lang)}/#{arguments[:id]}"
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
+        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(:delete_script, [
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -30,34 +30,37 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         arguments[:type] ||= UNDERSCORE_ALL
-
-        valid_params = [
-          :stored_fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_exclude,
-          :_source_include,
-          :version,
-          :version_type ]
-
         method = HTTP_HEAD
         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
 
         Utils.__rescue_from_not_found do
           perform_request(method, path, params, body).status == 200 ? true : false
         end
       end
-
       alias_method :exists?, :exists
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:exists, [
+          :stored_fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_exclude,
+          :_source_excludes,
+          :_source_include,
+          :_source_includes,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -47,8 +47,24 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+        method = HTTP_GET
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_explain'
+
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        body   = arguments[:body]
 
-        valid_params = [
+        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+
+        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(:explain, [
           :analyze_wildcard,
           :analyzer,
           :default_operator,
@@ -63,22 +79,10 @@ module Elasticsearch
           :source,
           :_source,
           :_source_include,
+          :_source_includes,
           :_source_exclude,
-          :stored_fields ]
-
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id]),
-                                 '_explain'
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body]
-
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
-
-        perform_request(method, path, params, body).body
-      end
+          :_source_excludes,
+          :stored_fields ].freeze)
     end
   end
 end

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

@@ -19,20 +19,22 @@ module Elasticsearch
       #
       def field_caps(arguments={})
         raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]
-
-        valid_params = [
-          :fields,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ]
-
         method = HTTP_GET
         path   = Utils.__pathify Utils.__listify(arguments[:index]), '_field_caps'
-        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(:field_caps, [
+          :fields,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ].freeze)
     end
   end
 end

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

@@ -14,19 +14,23 @@ module Elasticsearch
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html
       #
       def field_stats(arguments={})
-        valid_params = [
-          :fields,
-          :level,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ]
         method = 'GET'
         path   = Utils.__pathify Utils.__escape(arguments[:index]), "_field_stats"
-        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(:field_stats, [
+          :fields,
+          :level,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ].freeze)
     end
   end
 end

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

@@ -37,28 +37,12 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         arguments[:type] ||= UNDERSCORE_ALL
-
-        valid_params = [
-          :fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :version,
-          :version_type,
-          :_source,
-          :_source_include,
-          :_source_exclude,
-          :_source_transform,
-          :stored_fields ]
-
         method = HTTP_GET
         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
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
@@ -69,6 +53,26 @@ 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, [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :version,
+          :version_type,
+          :_source,
+          :_source_include,
+          :_source_includes,
+          :_source_exclude,
+          :_source_excludes,
+          :_source_transform,
+          :stored_fields ].freeze)
     end
   end
 end

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

@@ -5,15 +5,14 @@ module Elasticsearch
       # Retrieve an indexed script from Elasticsearch
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language (*Required*)
+      # @option arguments [String] :lang Script language
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
       #
       def get_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
-        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
         method = HTTP_GET
-        path   = "_scripts/#{arguments[:lang]}/#{arguments[:id]}"
+        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
         params = {}
         body   = nil
 

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

@@ -35,25 +35,13 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         arguments[:type] ||= UNDERSCORE_ALL
-
-        valid_params = [
-          :fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_include,
-          :_source_exclude ]
-
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  Utils.__escape(arguments[:id]),
                                  '_source'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = nil
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
@@ -62,6 +50,22 @@ 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_source, [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_include,
+          :_source_includes,
+          :_source_exclude,
+          :_source_excludes ].freeze)
     end
   end
 end

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

@@ -12,7 +12,7 @@ module Elasticsearch
       def get_template(arguments={})
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
         method = HTTP_GET
-        path   = "_search/template/#{arguments[:id]}"
+        path   = "_scripts/#{arguments[:id]}"
         params = {}
         body   = arguments[:body]
 

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

@@ -73,8 +73,21 @@ module Elasticsearch
       def index(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+        method = arguments[:id] ? HTTP_PUT : HTTP_POST
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id])
+
+        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(:index, [
           :consistency,
           :op_type,
           :parent,
@@ -87,18 +100,9 @@ module Elasticsearch
           :timestamp,
           :ttl,
           :version,
-          :version_type ]
-
-        method = arguments[:id] ? HTTP_PUT : HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
-
-        params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body]
-
-        perform_request(method, path, params, body).body
-      end
+          :version_type,
+          :if_seq_no,
+          :if_primary_term ].freeze)
     end
   end
 end

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

@@ -15,18 +15,17 @@ module Elasticsearch
         #
         # @example Analyze text "Quick Brown Jumping Fox" with a custom tokenizer and filter chain
         #
-        #     client.indices.analyze body: 'The Quick Brown Jumping Fox',
-        #                            tokenizer: 'whitespace',
-        #                            filters: ['lowercase','stop']
+        #     client.indices.analyze body: { text: 'The Quick Brown Jumping Fox',
+        #                                    tokenizer: 'whitespace',
+        #                                    filter: ['lowercase','stop'] }
         #
         # @note If your text for analysis is longer than 4096 bytes then you should use the :body argument, rather than :text, to avoid HTTP transport errors
         #
         # @example Analyze text "Quick <b>Brown</b> Jumping Fox" with custom tokenizer, token and character filters
         #
-        #     client.indices.analyze text: 'The Quick <b>Brown</b> Jumping Fox',
-        #                            tokenizer: 'standard',
-        #                            token_filters: 'lowercase,stop',
-        #                            char_filters: 'html_strip'
+        # client.indices.analyze body: { text: 'The Quick <b>Brown</b> Jumping Fox',
+        #                                tokenizer: 'standard',
+        #                                char_filter: ['html_strip'] }
         #
         # @option arguments [String] :index The name of the index to scope the operation
         # @option arguments [String] :body The text on which the analysis should be performed
@@ -44,12 +43,25 @@ module Elasticsearch
         # @option arguments [String] :text The text on which the analysis should be performed
         #                                  (when request body is not used)
         # @option arguments [String] :tokenizer The name of the tokenizer to use for the analysis
-        # @option arguments [String] :format Format of the output (options: detailed, text)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
         #
         def analyze(arguments={})
-          valid_params = [
+          method = HTTP_GET
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_analyze'
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
+
+          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(:analyze, [
             :analyzer,
             :char_filters,
             :explain,
@@ -61,19 +73,7 @@ module Elasticsearch
             :prefer_local,
             :text,
             :tokenizer,
-            :token_filters,
-            :format ]
-
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_analyze'
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
-
-          body   = arguments[:body]
-
-          perform_request(method, path, params, body).body
-        end
+            :token_filters ].freeze)
       end
     end
   end