elasticsearch-api 7.8.1 → 7.10.1

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-split-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-split-index.html
         #
         def split(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -61,7 +61,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -21,24 +21,21 @@ module Elasticsearch
       module Actions
         # Provides statistics on operations happening in an index.
         #
-        # @option arguments [List] :metric Limit the information returned the specific metrics.
-        #   (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 the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @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 [List] :groups A comma-separated list of search groups for `search` index metric
-        # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
-        #   (options: cluster,indices,shards)
+        # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
         # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
         # @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 [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 [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-stats.html
         #
         def stats(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -89,7 +86,7 @@ module Elasticsearch
           :suggest,
           :metric
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-aliases.html
         #
         def update_aliases(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -50,7 +50,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -23,14 +23,13 @@ module Elasticsearch
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @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] :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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
         # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-upgrade.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-upgrade.html
         #
         def upgrade(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -44,7 +43,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_upgrade"
                    else
                      "_upgrade"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -61,7 +60,7 @@ module Elasticsearch
           :wait_for_completion,
           :only_ancient_segments
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,17 +22,15 @@ module Elasticsearch
         # Allows a user to validate a potentially expensive query without executing it.
         #
         # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types   *Deprecated*
+        # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types *Deprecated*
         # @option arguments [Boolean] :explain Return detailed information about the error
         # @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] :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] :q Query in the Lucene query string syntax
         # @option arguments [String] :analyzer The analyzer to use for the query string
         # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
-        # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-        #   (options: AND,OR)
+        # @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] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
         # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
@@ -45,7 +43,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-validate.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-validate.html
         #
         def validate_query(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -56,14 +54,19 @@ module Elasticsearch
 
           _type = arguments.delete(:type)
 
-          method = Elasticsearch::API::HTTP_GET
-          path   = if _index && _type
-                     "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
-                   elsif _index
-                     "#{Utils.__listify(_index)}/_validate/query"
+          method = if arguments[:body]
+                     Elasticsearch::API::HTTP_POST
                    else
-                     "_validate/query"
-      end
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_validate/query"
+                 else
+                   "_validate/query"
+                 end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -87,7 +90,7 @@ module Elasticsearch
           :rewrite,
           :all_shards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/info.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 info(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -37,5 +37,5 @@ module Elasticsearch
         perform_request(method, path, params, body, headers).body
       end
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @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/delete-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/delete-pipeline-api.html
         #
         def delete_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -52,7 +52,7 @@ module Elasticsearch
           :master_timeout,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -25,7 +25,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/get-pipeline-api.html
         #
         def get_pipeline(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -39,7 +39,7 @@ module Elasticsearch
                      "_ingest/pipeline/#{Utils.__listify(_id)}"
                    else
                      "_ingest/pipeline"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -52,7 +52,7 @@ module Elasticsearch
         ParamsRegistry.register(:get_pipeline, [
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -23,7 +23,7 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/grok-processor.html#grok-processor-rest-get
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/grok-processor.html#grok-processor-rest-get
         #
         def processor_grok(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -37,7 +37,7 @@ module Elasticsearch
           body = nil
           perform_request(method, path, params, body, headers).body
         end
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The ingest definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/put-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/put-pipeline-api.html
         #
         def put_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -54,7 +54,7 @@ module Elasticsearch
           :master_timeout,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/ingest/simulate.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The simulate definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/simulate-pipeline-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/simulate-pipeline-api.html
         #
         def simulate(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -37,12 +37,12 @@ module Elasticsearch
 
           _id = arguments.delete(:id)
 
-          method = Elasticsearch::API::HTTP_GET
+          method = Elasticsearch::API::HTTP_POST
           path   = if _id
                      "_ingest/pipeline/#{Utils.__listify(_id)}/_simulate"
                    else
                      "_ingest/pipeline/_simulate"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -55,7 +55,7 @@ module Elasticsearch
         ParamsRegistry.register(:simulate, [
           :verbose
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -21,7 +21,7 @@ module Elasticsearch
       # Allows to get multiple documents in one request.
       #
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document   *Deprecated*
+      # @option arguments [String] :type The type of the document *Deprecated*
       # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
@@ -38,7 +38,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-multi-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-multi-get.html
       #
       def mget(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -51,14 +51,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)}/_mget"
                  elsif _index
                    "#{Utils.__listify(_index)}/_mget"
                  else
                    "_mget"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -79,5 +79,5 @@ module Elasticsearch
         :_source_includes
       ].freeze)
     end
-    end
+  end
 end

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

@@ -22,8 +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.
@@ -38,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]
@@ -51,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]
@@ -75,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
@@ -103,5 +100,5 @@ module Elasticsearch
         :ccs_minimize_roundtrips
       ].freeze)
     end
-    end
+  end
 end

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

@@ -22,8 +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
@@ -36,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]
@@ -49,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]
@@ -68,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
@@ -85,5 +84,5 @@ module Elasticsearch
         :ccs_minimize_roundtrips
       ].freeze)
     end
-    end
+  end
 end