elasticsearch-api 7.8.0.pre → 7.10.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8631e7e789c4a116ca7cda7f1fe7f9c0a8d5d3cfc73951298b752c9d31565bb
-  data.tar.gz: c882c6c8ba7584e27481956d454fdef4d92331f433b87c01da707b347e74dbfc
+  metadata.gz: c2400095c01ab8736317b44bd31cfc9019a2097c6d91e81c7c3244b330d79707
+  data.tar.gz: d1a72b5ff6ce15cb3611877aa22fb1be7828be81fdaebd2a07f1b83789194e7c
 SHA512:
-  metadata.gz: 58c19a5c9f4ef4567078fe79009423734fc65221a12d90a54021e064c5f9e4f56f09616387a7761b81a4e7b36880b778425c277a549de1624b2574e7a5565640
-  data.tar.gz: f606877161899a8c31186576c8906299ac796e82e303e28ae7c7f006785a2b526ce4454189da4311a9625a3e085117be91482558c051559f12bf67397a6527c7
+  metadata.gz: 894d646500df0a6c42947e77d2de7f9bfa91949d206be9e870a94ab90c79fc01d7d9661d88bac47d8eaa652264f6b56d35db5c416d8fd7fc251f61f4d229c1b7
+  data.tar.gz: 40ce7f4354b499556cbdc03ce84830ff0221c22365b6b990167ecc7c8ec9ae2da6731ac3f0edf78e6954cad2100a877750a812295407813dd3d760ee7da56f29

data/README.md

@@ -75,12 +75,13 @@ When you want to mix the library into your own client, it must conform to a foll
 * It responds to a `perform_request(method, path, params, body, headers)` method,
 * the method returns an object with `status`, `body` and `headers` methods.
 
-A simple client could look like this:
+A simple client could look like this (_with a dependency on `active_support` to parse the query params_):
 
 ```ruby
 require 'multi_json'
 require 'faraday'
 require 'elasticsearch/api'
+require 'active_support'
 
 class MySimpleClient
   include Elasticsearch::API
@@ -92,10 +93,25 @@ class MySimpleClient
 
     CONNECTION.run_request \
       method.downcase.to_sym,
-      path,
+      path_with_params(path, params),
       ( body ? MultiJson.dump(body): nil ),
       {'Content-Type' => 'application/json'}
   end
+  
+  private
+  
+  def path_with_params(path, params)
+    return path if params.blank?
+  
+    case params
+    when String
+      "#{path}?#{params}"
+    when Hash
+      "#{path}?#{params.to_query}"
+    else
+      raise ArgumentError, "Cannot parse params: '#{params}'"
+    end
+  end
 end
 
 client = MySimpleClient.new

data/elasticsearch-api.gemspec

@@ -39,8 +39,8 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
-  s.rdoc_options      = [ '--charset=UTF-8' ]
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
   s.required_ruby_version = '>= 2.4'
 

data/lib/elasticsearch/api.rb

@@ -71,7 +71,8 @@ module Elasticsearch
                 Elasticsearch::API::Snapshot,
                 Elasticsearch::API::Tasks,
                 Elasticsearch::API::Cat,
-                Elasticsearch::API::Remote
+                Elasticsearch::API::Remote,
+                Elasticsearch::API::DanglingIndices
     end
 
     # The serializer class

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

@@ -23,20 +23,19 @@ module Elasticsearch
       # @option arguments [String] :index Default index for items which don't provide one
       # @option arguments [String] :type Default document type for items which don't provide one
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
-      #   (options: true,false,wait_for)
-
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [String] :type Default document type for items which don't provide one
       # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
       # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
       # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
+      # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
+      # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-bulk.html
       #
       def bulk(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -56,7 +55,7 @@ module Elasticsearch
                    "#{Utils.__listify(_index)}/_bulk"
                  else
                    "_bulk"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -64,7 +63,7 @@ module Elasticsearch
           payload = Elasticsearch::API::Utils.__bulkify(body)
         else
           payload = body
-      end
+        end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
         perform_request(method, path, params, payload, headers).body
@@ -82,8 +81,9 @@ module Elasticsearch
         :_source,
         :_source_excludes,
         :_source_includes,
-        :pipeline
+        :pipeline,
+        :require_alias
       ].freeze)
     end
-    end
+  end
 end

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

@@ -28,12 +28,10 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @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 [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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-alias.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-alias.html
         #
         def aliases(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +45,7 @@ module Elasticsearch
                      "_cat/aliases/#{Utils.__listify(_name)}"
                    else
                      "_cat/aliases"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -67,7 +65,7 @@ module Elasticsearch
           :v,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,9 +23,7 @@ module Elasticsearch
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values
-        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
@@ -34,7 +32,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-allocation.html
         #
         def allocation(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -48,7 +46,7 @@ module Elasticsearch
                      "_cat/allocation/#{Utils.__listify(_node_id)}"
                    else
                      "_cat/allocation"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -69,7 +67,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-count.html
         #
         def count(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -43,7 +43,7 @@ module Elasticsearch
                      "_cat/count/#{Utils.__listify(_index)}"
                    else
                      "_cat/count"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -61,7 +61,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,17 +23,14 @@ module Elasticsearch
         #
         # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values
-        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [List] :fields A comma-separated list of fields to return in the output
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-fielddata.html
         #
         def fielddata(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +44,7 @@ module Elasticsearch
                      "_cat/fielddata/#{Utils.__listify(_fields)}"
                    else
                      "_cat/fielddata"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -66,7 +63,7 @@ module Elasticsearch
           :v,
           :fields
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,14 +25,12 @@ module Elasticsearch
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values
-        #   (options: d,h,m,s,ms,micros,nanos)
-
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :ts Set to false to disable timestamping
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-health.html
         #
         def health(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -60,7 +58,7 @@ module Elasticsearch
           :ts,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat.html
         #
         def help(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +47,7 @@ module Elasticsearch
           :help,
           :s
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,29 +23,21 @@ module Elasticsearch
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values
-        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
-        #   (options: green,yellow,red)
-
+        # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
         # @option arguments [Boolean] :help Return help information
         # @option arguments [Boolean] :pri Set to true to return stats only for primary shards
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values
-        #   (options: d,h,m,s,ms,micros,nanos)
-
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
-        # @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 [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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-indices.html
         #
         def indices(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -59,7 +51,7 @@ module Elasticsearch
                      "_cat/indices/#{Utils.__listify(_index)}"
                    else
                      "_cat/indices"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
@@ -85,7 +77,7 @@ module Elasticsearch
           :include_unloaded_segments,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-master.html
         #
         def master(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-nodeattrs.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-nodeattrs.html
         #
         def nodeattrs(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -21,23 +21,19 @@ module Elasticsearch
       module Actions
         # Returns basic statistics about performance of cluster nodes.
         #
-        # @option arguments [String] :bytes The unit in which to display byte values
-        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
-        # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false)   *Deprecated*
+        # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values
-        #   (options: d,h,m,s,ms,micros,nanos)
-
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-nodes.html
         #
         def nodes(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -68,7 +64,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,13 +27,11 @@ module Elasticsearch
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values
-        #   (options: d,h,m,s,ms,micros,nanos)
-
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-pending-tasks.html
         #
         def pending_tasks(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -62,7 +60,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end