elasticsearch-api 7.8.0 → 7.10.0

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

@@ -22,9 +22,7 @@ module Elasticsearch
       #
       # @option arguments [List] :index A comma-separated list of index names to use as default
       # @option arguments [List] :type A comma-separated list of document types to use as default
-      # @option arguments [String] :search_type Search operation type
-      #   (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
-
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
@@ -39,7 +37,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-multi-search.html
       #
       def msearch(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -52,14 +50,14 @@ module Elasticsearch
 
         _type = arguments.delete(:type)
 
-        method = Elasticsearch::API::HTTP_GET
+        method = Elasticsearch::API::HTTP_POST
         path   = if _index && _type
                    "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch"
                  elsif _index
                    "#{Utils.__listify(_index)}/_msearch"
                  else
                    "_msearch"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -76,16 +74,14 @@ module Elasticsearch
                     end
                     .map { |item| Elasticsearch::API.serializer.dump(item) }
           payload << "" unless payload.empty?
-          payload = payload.join("
-")
+          payload = payload.join("\n")
         when body.is_a?(Array)
           payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
           payload << "" unless payload.empty?
-          payload = payload.join("
-")
+          payload = payload.join("\n")
         else
           payload = body
-      end
+        end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
         perform_request(method, path, params, payload, headers).body
@@ -104,5 +100,5 @@ module Elasticsearch
         :ccs_minimize_roundtrips
       ].freeze)
     end
-    end
+  end
 end

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

@@ -22,9 +22,7 @@ module Elasticsearch
       #
       # @option arguments [List] :index A comma-separated list of index names to use as default
       # @option arguments [List] :type A comma-separated list of document types to use as default
-      # @option arguments [String] :search_type Search operation type
-      #   (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
-
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
@@ -37,7 +35,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-multi-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-multi-search.html
       #
       def msearch_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -50,14 +48,14 @@ module Elasticsearch
 
         _type = arguments.delete(:type)
 
-        method = Elasticsearch::API::HTTP_GET
+        method = Elasticsearch::API::HTTP_POST
         path   = if _index && _type
                    "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch/template"
                  elsif _index
                    "#{Utils.__listify(_index)}/_msearch/template"
                  else
                    "_msearch/template"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -69,7 +67,7 @@ module Elasticsearch
 ")
         else
           payload = body
-      end
+        end
 
         headers.merge!("Content-Type" => "application/x-ndjson")
         perform_request(method, path, params, payload, headers).body
@@ -86,5 +84,5 @@ module Elasticsearch
         :ccs_minimize_roundtrips
       ].freeze)
     end
-    end
+  end
 end

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

@@ -33,9 +33,7 @@ module Elasticsearch
       # @option arguments [String] :routing Specific routing value. 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] :headers Custom HTTP headers
       # @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.
       #
@@ -44,7 +42,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-multi-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-multi-termvectors.html
       #
       def mtermvectors(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -56,21 +54,26 @@ module Elasticsearch
 
         _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"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
                  else
-                   "_mtermvectors"
-    end
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        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, headers).body
       end
 
@@ -92,5 +95,5 @@ module Elasticsearch
         :version_type
       ].freeze)
     end
-    end
+  end
 end

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

@@ -26,9 +26,7 @@ module Elasticsearch
         # @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
         # @option arguments [Hash] :headers Custom HTTP headers
         #
@@ -37,7 +35,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cluster-nodes-hot-threads.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-hot-threads.html
         #
         def hot_threads(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -51,7 +49,7 @@ module Elasticsearch
                      "_cluster/nodes/#{Utils.__listify(_node_id)}/hot_threads"
                    else
                      "_cluster/nodes/hot_threads"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -69,7 +67,7 @@ module Elasticsearch
           :type,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,14 +22,12 @@ module Elasticsearch
         # Returns information about nodes 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 [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 [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
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cluster-nodes-info.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-info.html
         #
         def info(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -49,7 +47,7 @@ module Elasticsearch
                      "_nodes/#{Utils.__listify(_metric)}"
                    else
                      "_nodes"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -63,7 +61,7 @@ module Elasticsearch
           :flat_settings,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/secure-settings.html#reloadable-secure-settings
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/secure-settings.html#reloadable-secure-settings
         #
         def reload_secure_settings(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -40,7 +40,7 @@ module Elasticsearch
                      "_nodes/#{Utils.__listify(_node_id)}/reload_secure_settings"
                    else
                      "_nodes/reload_secure_settings"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -53,7 +53,7 @@ module Elasticsearch
         ParamsRegistry.register(:reload_secure_settings, [
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,25 +22,19 @@ module Elasticsearch
         # Returns statistical information about nodes 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 [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] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
+        # @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)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cluster-nodes-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -66,7 +60,7 @@ module Elasticsearch
                      "_nodes/stats/#{Utils.__listify(_metric)}"
                    else
                      "_nodes/stats"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -86,7 +80,7 @@ module Elasticsearch
           :timeout,
           :include_segment_file_sizes
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,13 +22,11 @@ module Elasticsearch
         # Returns low-level information about REST actions usage on nodes.
         #
         # @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 [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cluster-nodes-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-usage.html
         #
         def usage(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -48,7 +46,7 @@ module Elasticsearch
                      "_nodes/usage/#{Utils.__listify(_metric)}"
                    else
                      "_nodes/usage"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -61,7 +59,7 @@ module Elasticsearch
         ParamsRegistry.register(:usage, [
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,7 +22,7 @@ module Elasticsearch
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/index.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/index.html
       #
       def ping(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -45,5 +45,5 @@ module Elasticsearch
       end
       end
     end
-    end
+  end
 end

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

@@ -24,11 +24,10 @@ module Elasticsearch
       # @option arguments [String] :context Script context
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Time] :master_timeout Specify timeout for connection to master
-      # @option arguments [String] :context Context name to compile script against
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-scripting.html
       #
       def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -47,7 +46,7 @@ module Elasticsearch
                    "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
                  else
                    "_scripts/#{Utils.__listify(_id)}"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -63,5 +62,5 @@ module Elasticsearch
         :context
       ].freeze)
     end
-    end
+  end
 end

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

@@ -19,20 +19,20 @@ module Elasticsearch
   module API
     module Actions
       # Allows to evaluate the quality of ranked search results over a set of typical search queries
+      # This functionality is Experimental and may be changed or removed
+      # completely in a future release. Elastic will take a best effort approach
+      # to fix any issues, but experimental features are not subject to the
+      # support SLA of official GA features.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       # @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 [String] :search_type Search operation type
-      #   (options: query_then_fetch,dfs_query_then_fetch)
-
+      # @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] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-rank-eval.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-rank-eval.html
       #
       def rank_eval(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -43,12 +43,12 @@ module Elasticsearch
 
         _index = arguments.delete(:index)
 
-        method = Elasticsearch::API::HTTP_GET
+        method = Elasticsearch::API::HTTP_POST
         path   = if _index
                    "#{Utils.__listify(_index)}/_rank_eval"
                  else
                    "_rank_eval"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -65,5 +65,5 @@ module Elasticsearch
         :search_type
       ].freeze)
     end
-    end
+  end
 end