elasticsearch-api 7.8.1 → 7.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c9c47132b13f15a6bb13394a409217a1e91101687e7201e44a2c28cf90ad78b
-  data.tar.gz: 3a522cd5bdcdabd6adb0c6ab2baa3871c769f887ebcae75491cdd98e8cbde9a2
+  metadata.gz: bc7d8b93ca6d897957c2e813018d788d4f320e5b19b16727aff5a9aec4f6c23e
+  data.tar.gz: 8632ca3f2168b784214375ffd30e196831848c20dad9e487bbaee04cc60bcffa
 SHA512:
-  metadata.gz: 047757a9940d621a4e1b71241d96f4090e8d603423f94a60d43c6967f269c54a3468884ef407e8eaa4ef2c337c56394b3dbdd08c3e840e8dd7aa15cf3675d754
-  data.tar.gz: 366ee588648c6b3ee712a975fb5c9dfed47b3d59ba04a8e6e26169736bf26f4f108ef28048004ea76911090a6e4130ac7ec1b8635332ed2702b249e36e7dfa6b
+  metadata.gz: ff55062ee8efa2c396f53fc6d4cb1a847dafadf50bfdc6153fafb824005411e12af24ac931414d0672aa5e3453ae0ce01bea2eef75aacab21c7a50df0e164c00
+  data.tar.gz: f695ac23cf2e71fe7246b55750d6c00e8996bd290b3857b600ade1c7880dd78021341a1bf324a203c7563f9e0cbb56662792f089de4048eef1dbdda7d6bae1ce

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/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,19 +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]
@@ -55,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]
@@ -63,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
@@ -81,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,11 +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) || {}
@@ -46,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]
 
@@ -66,7 +65,7 @@ module Elasticsearch
           :v,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,8 +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
@@ -33,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) || {}
@@ -47,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]
 
@@ -68,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,16 +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) || {}
@@ -46,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
@@ -65,7 +63,7 @@ module Elasticsearch
           :v,
           :fields
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -25,13 +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) || {}
@@ -59,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,25 +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) || {}
@@ -55,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]
 
@@ -81,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,21 +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) || {}
@@ -66,7 +64,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,12 +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) || {}
@@ -61,7 +60,7 @@ module Elasticsearch
           :time,
           :v
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/cat/plugins.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-plugins.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-plugins.html
         #
         def plugins(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module Elasticsearch
           :s,
           :v
         ].freeze)
-end
       end
+    end
   end
 end