elasticsearch-api 7.8.1 → 7.9.0.pre

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

@@ -28,6 +28,7 @@ module Elasticsearch
         # @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 [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
@@ -36,7 +37,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.x/cluster-nodes-hot-threads.html
         #
         def hot_threads(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -50,7 +51,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
@@ -68,7 +69,7 @@ module Elasticsearch
           :type,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -24,11 +24,12 @@ module Elasticsearch
         # @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
         # @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.x/cluster-nodes-info.html
         #
         def info(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -48,7 +49,7 @@ module Elasticsearch
                      "_nodes/#{Utils.__listify(_metric)}"
                    else
                      "_nodes"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -62,7 +63,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.x/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

@@ -23,21 +23,24 @@ module Elasticsearch
         #
         # @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)
+        #   (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 [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.x/cluster-nodes-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -63,7 +66,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
@@ -83,7 +86,7 @@ module Elasticsearch
           :timeout,
           :include_segment_file_sizes
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -24,10 +24,11 @@ module Elasticsearch
         # @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
         # @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.x/cluster-nodes-usage.html
         #
         def usage(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +48,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
@@ -60,7 +61,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.x/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

@@ -28,7 +28,7 @@ module Elasticsearch
       # @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.x/modules-scripting.html
       #
       def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -47,7 +47,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 +63,5 @@ module Elasticsearch
         :context
       ].freeze)
     end
-    end
+  end
 end

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

@@ -19,22 +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 [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.x/search-rank-eval.html
       #
       def rank_eval(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -45,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]
@@ -67,5 +65,5 @@ module Elasticsearch
         :search_type
       ].freeze)
     end
-    end
+  end
 end

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

@@ -33,7 +33,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
       #
       def reindex(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -64,5 +64,5 @@ module Elasticsearch
         :max_docs
       ].freeze)
     end
-    end
+  end
 end

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.  (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
       #
       def reindex_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
@@ -50,5 +50,5 @@ module Elasticsearch
         :requests_per_second
       ].freeze)
     end
-    end
+  end
 end

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition template and its params
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-template.html#_validating_templates
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-template.html#_validating_templates
       #
       def render_search_template(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -33,17 +33,22 @@ module Elasticsearch
 
         _id = arguments.delete(:id)
 
-        method = Elasticsearch::API::HTTP_GET
-        path   = if _id
-                   "_render/template/#{Utils.__listify(_id)}"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
                  else
-                   "_render/template"
-    end
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = if _id
+                 "_render/template/#{Utils.__listify(_id)}"
+               else
+                 "_render/template"
+               end
         params = {}
 
         body = arguments[:body]
         perform_request(method, path, params, body, headers).body
       end
     end
-    end
+  end
 end

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

@@ -19,28 +19,29 @@ module Elasticsearch
   module API
     module Actions
       # Allows an arbitrary script to be executed and a result to be returned
-      # 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 [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The script to execute
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.8/painless-execute-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.x/painless-execute-api.html
       #
       def scripts_painless_execute(arguments = {})
         headers = arguments.delete(:headers) || {}
 
         arguments = arguments.clone
 
-        method = Elasticsearch::API::HTTP_GET
-        path   = "_scripts/painless/_execute"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = "_scripts/painless/_execute"
         params = {}
 
         body = arguments[:body]
         perform_request(method, path, params, body, headers).body
       end
     end
-    end
+  end
 end

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

@@ -32,7 +32,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-request-body.html#request-body-search-scroll
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-request-body.html#request-body-search-scroll
       #
       def scroll(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -41,12 +41,17 @@ module Elasticsearch
 
         _scroll_id = arguments.delete(:scroll_id)
 
-        method = Elasticsearch::API::HTTP_GET
-        path   = if _scroll_id
-                   "_search/scroll/#{Utils.__listify(_scroll_id)}"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
                  else
-                   "_search/scroll"
-    end
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = if _scroll_id
+                 "_search/scroll/#{Utils.__listify(_scroll_id)}"
+               else
+                 "_search/scroll"
+               end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -62,5 +67,5 @@ module Elasticsearch
         :rest_total_hits_as_int
       ].freeze)
     end
-    end
+  end
 end

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

@@ -27,6 +27,7 @@ module Elasticsearch
       # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
       #   (options: AND,OR)
+
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
       # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -37,6 +38,7 @@ module Elasticsearch
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
       #   (options: open,closed,hidden,none,all)
+
       # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [String] :q Query in the Lucene query string syntax
@@ -44,6 +46,7 @@ module Elasticsearch
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
       # @option arguments [String] :search_type Search operation type
       #   (options: query_then_fetch,dfs_query_then_fetch)
+
       # @option arguments [Number] :size Number of hits to return (default: 10)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -54,6 +57,7 @@ module Elasticsearch
       # @option arguments [String] :suggest_field Specify which field to use for suggestions
       # @option arguments [String] :suggest_mode Specify suggest mode
       #   (options: missing,popular,always)
+
       # @option arguments [Number] :suggest_size How many suggestions to return in response
       # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
       # @option arguments [Time] :timeout Explicit operation timeout
@@ -76,7 +80,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-search.html
       #
       def search(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -88,14 +92,19 @@ module Elasticsearch
 
         _type = arguments.delete(:type)
 
-        method = Elasticsearch::API::HTTP_GET
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
-                 elsif _index
-                   "#{Utils.__listify(_index)}/_search"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
                  else
-                   "_search"
-    end
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = if _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
+               elsif _index
+                 "#{Utils.__listify(_index)}/_search"
+               else
+                 "_search"
+               end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -150,5 +159,5 @@ module Elasticsearch
         :rest_total_hits_as_int
       ].freeze)
     end
-    end
+  end
 end