elasticsearch-api 7.3.0 → 7.5.0

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

@@ -5,17 +5,10 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Returns information and statistics about terms in the fields of multiple documents
-      # in a single request/response. The semantics are similar to the {#mget} API.
-      #
-      # @example Return information about multiple documents in a specific index
-      #
-      #     subject.mtermvectors index: 'my-index', type: 'my-type', body: { ids: [1, 2, 3] }
+      # Returns multiple termvectors in one request.
       #
       # @option arguments [String] :index The index in which the document resides.
       # @option arguments [String] :type The type of the document.
-      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
       # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
@@ -25,52 +18,63 @@ module Elasticsearch
       # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [String] :parent Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".
       # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :version_type Specific version type
+      #   (options: internal,external,external_gte,force)
+
+      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see #mget
-      # @see #termvector
       #
-      def mtermvectors(arguments={})
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-multi-termvectors.html
+      #
+      def mtermvectors(arguments = {})
+        arguments = arguments.clone
         ids = arguments.delete(:ids)
 
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 '_mtermvectors'
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_mtermvectors"
+                 else
+                   "_mtermvectors"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         if ids
           body = { :ids => ids }
         else
           body = arguments[:body]
-        end
-
+    end
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:mtermvectors, [
-          :ids,
-          :term_statistics,
-          :field_statistics,
-          :fields,
-          :offsets,
-          :positions,
-          :payloads,
-          :preference,
-          :routing,
-          :parent,
-          :realtime,
-          :version,
-          :version_type ].freeze)
+        :ids,
+        :term_statistics,
+        :field_statistics,
+        :fields,
+        :offsets,
+        :positions,
+        :payloads,
+        :preference,
+        :routing,
+        :realtime,
+        :version,
+        :version_type
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -6,50 +6,55 @@ module Elasticsearch
   module API
     module Nodes
       module Actions
-
-        # Returns information about the hottest threads in the cluster or on a specific node as a String.
-        #
-        #
-        # The information is returned as text, and allows you to understand what are currently
-        # the most taxing operations happening in the cluster, for debugging or monitoring purposes.
-        #
-        # @example Return 10 hottest threads
-        #
-        #     client.nodes.hot_threads threads: 10
+        # Returns information about hot threads on each node in the cluster.
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [Time] :interval The interval for the second sampling of threads
         # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
         # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
         # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
-        # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
+        # @option arguments [String] :type The type to sample (default: cpu)
+        #   (options: cpu,wait,block)
+
         # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @return [String]
+        # *Deprecation notice*:
+        # The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons
+        # Deprecated since version 7.0.0
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
-        def hot_threads(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'hot_threads'
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-nodes-hot-threads.html
+        #
+        def hot_threads(arguments = {})
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cluster/nodes/#{Utils.__listify(_node_id)}/hot_threads"
+                   else
+                     "_cluster/nodes/hot_threads"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:hot_threads, [
-            :interval,
-            :snapshots,
-            :threads,
-            :ignore_idle_threads,
-            :type,
-            :timeout ].freeze)
+          :interval,
+          :snapshots,
+          :threads,
+          :ignore_idle_threads,
+          :type,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,83 +6,49 @@ module Elasticsearch
   module API
     module Nodes
       module Actions
-
-        # Returns information about nodes in the cluster (cluster settings, JVM version, etc).
-        #
-        # Use the `all` option to return all available settings, or limit the information returned
-        # to a specific type (eg. `http`).
-        #
-        # Use the `node_id` option to limit information to specific node(s).
-        #
-        # @example Return information about JVM
-        #
-        #     client.nodes.info jvm: true
-        #
-        # @example Return information about HTTP and network
-        #
-        #     client.nodes.info http: true, network: true
-        #
-        # @example Pass a list of metrics
+        # Returns information about nodes in the cluster.
         #
-        #     client.nodes.info metric: ['http', 'network']
-        #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
-        #                                   use `_local` to return information from the node you're connecting to, leave
-        #                                   empty to get information from all nodes
-        # @option arguments [Boolean] :_all Return all available information
-        # @option arguments [Boolean] :http Return information about HTTP
-        # @option arguments [Boolean] :jvm Return information about the JVM
-        # @option arguments [Boolean] :network Return information about network
-        # @option arguments [Boolean] :os Return information about the operating system
-        # @option arguments [Boolean] :plugins Return information about plugins
-        # @option arguments [Boolean] :process Return information about the Elasticsearch process
-        # @option arguments [Boolean] :settings Return information about node settings
-        # @option arguments [Boolean] :thread_pool Return information about the thread pool
-        # @option arguments [Boolean] :transport Return information about transport
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all.
+        #   (options: settings,os,process,jvm,thread_pool,transport,http,plugins,ingest)
+
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-nodes-info.html
         #
-        def info(arguments={})
+        def info(arguments = {})
           arguments = arguments.clone
-          metric    = arguments.delete(:metric)
-          method = HTTP_GET
-          if metric
-            parts = metric
-          else
-            parts = Utils.__extract_parts arguments, ParamsRegistry.get(:info_parts)
-          end
 
-          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), Utils.__listify(parts)
+          _node_id = arguments.delete(:node_id)
+
+          _metric = arguments.delete(:metric)
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:info_params)
-          body   = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id && _metric
+                     "_nodes/#{Utils.__listify(_node_id)}/#{Utils.__listify(_metric)}"
+                   elsif _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}"
+                   elsif _metric
+                     "_nodes/#{Utils.__listify(_metric)}"
+                   else
+                     "_nodes"
+end
+          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.1.1
-        ParamsRegistry.register(:info_params, [ :flat_settings, :timeout ].freeze)
-
-        # Register this action with its valid parts when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:info_parts, [
-            :_all,
-            :http,
-            :jvm,
-            :network,
-            :os,
-            :plugins,
-            :process,
-            :settings,
-            :thread_pool,
-            :transport,
-            :timeout ].freeze)
+        # @since 6.2.0
+        ParamsRegistry.register(:info, [
+          :flat_settings,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module Nodes
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.

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

@@ -6,36 +6,38 @@ module Elasticsearch
   module API
     module Nodes
       module Actions
-
-        # Re-read the local node's encrypted keystore. Specifically, it will prompt the keystore
-        # decryption and reading across the cluster.
-        #
-        # @example Reload secure settings for all nodes
-        #
-        #     client.nodes.reload_secure_settings
-        #
-        # @example Reload secure settings for a list of nodes
-        #
-        #     client.nodes.reload_secure_settings(node_id: 'foo,bar')
+        # Reloads secure settings.
         #
-        # @option arguments [ Array ] :node_id A comma-separated list of node IDs or names to perform the operation on
-        # @option arguments [ String ] :timeout Explicit operation timeout
+        # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
+        # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/secure-settings.html#reloadable-secure-settings
         #
-        def reload_secure_settings(arguments={})
-          valid_params = [
-              :timeout ]
+        def reload_secure_settings(arguments = {})
+          arguments = arguments.clone
 
-          method = HTTP_POST
-          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'reload_secure_settings'
+          _node_id = arguments.delete(:node_id)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
-          body   = nil
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/reload_secure_settings"
+                   else
+                     "_nodes/reload_secure_settings"
+end
+          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(:reload_secure_settings, [
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,7 +6,6 @@ module Elasticsearch
   module API
     module Nodes
       module Actions
-
         # Shutdown one or all nodes
         #
         # @example Shut down node named _Bloke_
@@ -21,7 +20,7 @@ module Elasticsearch
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
-        def shutdown(arguments={})
+        def shutdown(arguments = {})
           method = HTTP_POST
           path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
 
@@ -35,8 +34,9 @@ module Elasticsearch
         #
         # @since 6.1.1
         ParamsRegistry.register(:shutdown, [
-            :delay,
-            :exit ].freeze)
+          :delay,
+          :exit
+        ].freeze)
       end
     end
   end

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

@@ -6,65 +6,72 @@ module Elasticsearch
   module API
     module Nodes
       module Actions
-
         # Returns statistical information about nodes in the cluster.
         #
-        # @example Return statistics about JVM
-        #
-        #     client.nodes.stats metric: 'jvm'
-        #
-        # @example Return statistics about field data structures for all fields
-        #
-        #     client.nodes.stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
-        #
-        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery)
-        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :metric Limit the information returned to the specified metrics
+        #   (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery)
+
+        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.
+        #   (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
+
         # @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] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
         # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
-        # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
+        # @option arguments [String] :level Return indices stats aggregated at index, node or shard level
+        #   (options: indices,node,shards)
+
         # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-nodes-stats.html
         #
-        def stats(arguments={})
+        def stats(arguments = {})
           arguments = arguments.clone
-          node_id = arguments.delete(:node_id)
 
-          path   = Utils.__pathify '_nodes',
-                                   Utils.__listify(node_id),
-                                   'stats',
-                                   Utils.__listify(arguments.delete(:metric)),
-                                   Utils.__listify(arguments.delete(:index_metric))
+          _node_id = arguments.delete(:node_id)
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          _metric = arguments.delete(:metric)
 
-          [:completion_fields, :fielddata_fields, :fields, :groups, :types].each do |key|
-            params[key] = Utils.__listify(params[key]) if params[key]
-          end
+          _index_metric = arguments.delete(:index_metric)
 
-          body   = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id && _metric && _index_metric
+                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
+                   elsif _metric && _index_metric
+                     "_nodes/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
+                   elsif _node_id && _metric
+                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}"
+                   elsif _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/stats"
+                   elsif _metric
+                     "_nodes/stats/#{Utils.__listify(_metric)}"
+                   else
+                     "_nodes/stats"
+end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-          perform_request(HTTP_GET, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:stats, [
-            :completion_fields,
-            :fielddata_fields,
-            :fields,
-            :groups,
-            :level,
-            :types,
-            :timeout,
-            :include_segment_file_sizes ].freeze)
+          :completion_fields,
+          :fielddata_fields,
+          :fields,
+          :groups,
+          :level,
+          :types,
+          :timeout,
+          :include_segment_file_sizes
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -1,22 +1,42 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 module Elasticsearch
   module API
     module Nodes
       module Actions
-
-        # The cluster nodes usage API allows to retrieve information on the usage of features for each node.
+        # Returns low-level information about REST actions usage on nodes.
         #
-        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,rest_actions)
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :metric Limit the information returned to the specified metrics
+        #   (options: _all,rest_actions)
+
         # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-nodes-usage.html
         #
-        def usage(arguments={})
+        def usage(arguments = {})
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          _metric = arguments.delete(:metric)
+
           method = Elasticsearch::API::HTTP_GET
-          path   = "_nodes/usage"
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          path   = if _node_id && _metric
+                     "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}"
+                   elsif _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/usage"
+                   elsif _metric
+                     "_nodes/usage/#{Utils.__listify(_metric)}"
+                   else
+                     "_nodes/usage"
+end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
@@ -24,8 +44,9 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:usage, [
-            :timeout ].freeze)
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,7 +6,6 @@ module Elasticsearch
   module API
     module Actions
       module ParamsRegistry
-
         extend self
 
         # A Mapping of all the actions to their list of valid params.

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

@@ -5,31 +5,30 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Returns true if the cluster returns a successful HTTP response, false otherwise.
-      #
-      # @example
+      # Returns whether the cluster is running.
       #
-      #     client.ping
+
       #
-      # @see http://elasticsearch.org/guide/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index.html
       #
-      def ping(arguments={})
-        method = HTTP_HEAD
+      def ping(arguments = {})
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_HEAD
         path   = ""
         params = {}
-        body   = nil
 
+        body = nil
         begin
-          perform_request(method, path, params, body).status == 200 ? true : false
+        perform_request(method, path, params, body).status == 200 ? true : false
         rescue Exception => e
-          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
+          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
             false
           else
             raise e
           end
-        end
       end
+      end
+    end
     end
-  end
 end