elasticsearch-api 7.17.7 → 8.0.0.pre1

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

@@ -28,33 +28,27 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def simulate_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_index_template/_simulate_index/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:simulate_index_template, [
-          :create,
-          :cause,
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -28,11 +28,13 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def simulate_template(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
@@ -43,20 +45,12 @@ module Elasticsearch
                    else
                      "_index_template/_simulate"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:simulate_template, [
-          :create,
-          :cause,
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -23,14 +23,13 @@ module Elasticsearch
         #
         # @option arguments [String] :index The name of the source index to split
         # @option arguments [String] :target The name of the target index to split into
-        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-split-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
         #
         def split(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -38,6 +37,8 @@ module Elasticsearch
 
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
@@ -46,21 +47,12 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "#{Utils.__listify(_index)}/_split/#{Utils.__listify(_target)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         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

@@ -21,10 +21,10 @@ module Elasticsearch
       module Actions
         # Provides statistics on operations happening in an index.
         #
-        # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
+        # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk)
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
-        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
+        # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards)
+        # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards)
         # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
         # @option arguments [List] :groups A comma-separated list of search groups for `search` index metric
         # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
@@ -35,57 +35,35 @@ module Elasticsearch
         # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}
 
-          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, headers).body
-        end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:stats_params, [
-          :completion_fields,
-          :fielddata_fields,
-          :fields,
-          :groups,
-          :level,
-          :types,
-          :include_segment_file_sizes,
-          :include_unloaded_segments,
-          :expand_wildcards,
-          :forbid_closed_indices
-        ].freeze)
+          arguments = arguments.clone
+
+          _metric = arguments.delete(:metric)
 
-        ParamsRegistry.register(:stats_parts, [
-          :_all,
-          :completion,
-          :docs,
-          :fielddata,
-          :query_cache,
-          :flush,
-          :get,
-          :indexing,
-          :merge,
-          :request_cache,
-          :refresh,
-          :search,
-          :segments,
-          :store,
-          :warmer,
-          :suggest,
-          :metric
-        ].freeze)
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index && _metric
+                     "#{Utils.__listify(_index)}/_stats/#{Utils.__listify(_metric)}"
+                   elsif _metric
+                     "_stats/#{Utils.__listify(_metric)}"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_stats"
+                   else
+                     "_stats"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/{upgrade.rb → unfreeze.rb}

@@ -19,52 +19,43 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # DEPRECATED Upgrades to the current version of Lucene.
+        # Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+        # @option arguments [String] :index The name of the index to unfreeze
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
-        # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
+        # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # *Deprecation notice*:
-        # The _upgrade API is no longer useful and will be removed. Instead, see _reindex API.
-        # Deprecated since version 8.0.0
+        # Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.
+        # Deprecated since version 7.14.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-upgrade.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html
         #
-        def upgrade(arguments = {})
+        def unfreeze(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = if _index
-                     "#{Utils.__listify(_index)}/_upgrade"
-                   else
-                     "_upgrade"
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "#{Utils.__listify(_index)}/_unfreeze"
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:upgrade, [
-          :allow_no_indices,
-          :expand_wildcards,
-          :ignore_unavailable,
-          :wait_for_completion,
-          :only_ancient_segments
-        ].freeze)
       end
     end
   end

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

@@ -26,30 +26,25 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
         #
         def update_aliases(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_aliases"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:update_aliases, [
-          :timeout,
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -43,18 +43,20 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-validate.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html
         #
         def validate_query(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           _type = arguments.delete(:type)
 
-          method = if arguments[:body]
+          method = if body
                      Elasticsearch::API::HTTP_POST
                    else
                      Elasticsearch::API::HTTP_GET
@@ -67,29 +69,12 @@ module Elasticsearch
                    else
                      "_validate/query"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:validate_query, [
-          :explain,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :q,
-          :analyzer,
-          :analyze_wildcard,
-          :default_operator,
-          :df,
-          :lenient,
-          :rewrite,
-          :all_shards
-        ].freeze)
       end
     end
   end

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

@@ -22,19 +22,22 @@ module Elasticsearch
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
       #
       def info(arguments = {})
         headers = arguments.delete(:headers) || {}
 
+        body = nil
+
         arguments = arguments.clone
 
         method = Elasticsearch::API::HTTP_GET
         path   = ""
         params = {}
 
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -26,32 +26,27 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/delete-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html
         #
         def delete_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_pipeline, [
-          :master_timeout,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb

@@ -23,19 +23,22 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/geoip-stats-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html
         #
         def geo_ip_stats(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_ingest/geoip/stats"
           params = {}
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
       end
     end

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -26,11 +26,13 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/get-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html
         #
         def get_pipeline(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _id = arguments.delete(:id)
@@ -41,19 +43,12 @@ module Elasticsearch
                    else
                      "_ingest/pipeline"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_pipeline, [
-          :summary,
-          :master_timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -23,19 +23,22 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/grok-processor.html#grok-processor-rest-get
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get
         #
         def processor_grok(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_ingest/processor/grok"
           params = {}
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
       end
     end

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -22,13 +22,12 @@ module Elasticsearch
         # Creates or updates a pipeline.
         #
         # @option arguments [String] :id Pipeline ID
-        # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The ingest definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/put-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html
         #
         def put_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -36,26 +35,20 @@ module Elasticsearch
 
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:put_pipeline, [
-          :if_version,
-          :master_timeout,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/simulate.rb

@@ -26,13 +26,15 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The simulate definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/simulate-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html
         #
         def simulate(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
           headers = arguments.delete(:headers) || {}
 
+          body = arguments.delete(:body)
+
           arguments = arguments.clone
 
           _id = arguments.delete(:id)
@@ -43,18 +45,12 @@ module Elasticsearch
                    else
                      "_ingest/pipeline/_simulate"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:simulate, [
-          :verbose
-        ].freeze)
       end
     end
   end