elasticsearch-api 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,82 +19,43 @@ 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
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html
         #
-        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
+        def info(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), Utils.__listify(parts)
+          body = nil
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:info_params)
-          body   = nil
+          arguments = arguments.clone
 
-          perform_request(method, path, params, body).body
-        end
+          _node_id = arguments.delete(:node_id)
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:info_params, [ :flat_settings, :timeout ].freeze)
+          _metric = arguments.delete(:metric)
 
-        # 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)
+          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.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,34 +19,35 @@ 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
+        # Reloads secure settings.
         #
-        #     client.nodes.reload_secure_settings(node_id: 'foo,bar')
+        # @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
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore
         #
-        # @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
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings
         #
-        # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
-        #
-        def reload_secure_settings(arguments={})
-          valid_params = [
-              :timeout ]
+        def reload_secure_settings(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          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.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
       end
     end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -19,64 +19,57 @@ 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] :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] :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, bulk, shards)
+        # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards)
+        # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `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 [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
         #
-        def stats(arguments={})
+        def stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
           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.process_params(arguments)
 
-          perform_request(HTTP_GET, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:stats, [
-            :completion_fields,
-            :fielddata_fields,
-            :fields,
-            :groups,
-            :level,
-            :types,
-            :timeout,
-            :include_segment_file_sizes ].freeze)
       end
     end
   end

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

@@ -1,30 +1,60 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 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
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html
         #
-        def usage(arguments={})
+        def usage(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          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.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:usage, [
-            :timeout ].freeze)
       end
     end
   end

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

@@ -0,0 +1,54 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Actions
+      # Open a point in time that can be used in subsequent searches
+      #
+      # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @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] :keep_alive Specific the time to live for the point in time
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html
+      #
+      def open_point_in_time(arguments = {})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        headers = arguments.delete(:headers) || {}
+
+        body = nil
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = "#{Utils.__listify(_index)}/_pit"
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -18,25 +18,27 @@
 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
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see http://elasticsearch.org/guide/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
       #
-      def ping(arguments={})
-        method = HTTP_HEAD
+      def ping(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        body = nil
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_HEAD
         path   = ""
         params = {}
-        body   = nil
 
         begin
-          perform_request(method, path, params, body).status == 200 ? true : false
+          perform_request(method, path, params, body, headers).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

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -18,52 +18,43 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Store a script in an internal index (`.scripts`), to be able to reference them
-      # in search definitions (with dynamic scripting disabled)
-      #
-      # @example Storing an Mvel script in Elasticsearch and using it in function score
-      #
-      #     client.put_script lang: 'groovy', id: 'my_score', body: { script: 'log(_score * factor)' }
+      # Creates or updates a script.
       #
-      #     client.search body: {
-      #       query: {
-      #         function_score: {
-      #           query: { match: { title: 'foo' } },
-      #           functions: [ { script_score: { script_id: 'my_score', params: { factor: 3 } } } ]
-      #         }
-      #       }
-      #     }
-      #
-      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :id Script ID
       # @option arguments [String] :context Script context
-      # @option arguments [Hash] :body The document (*Required*)
       # @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/master/modules-scripting.html#_indexed_scripts
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
       #
-      def put_script(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+      def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_PUT
-        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        headers = arguments.delete(:headers) || {}
 
-        body   = arguments[:body]
+        body = arguments.delete(:body)
 
-        perform_request(method, path, params, body).body
-      end
+        arguments = arguments.clone
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:put_script, [
-          :timeout,
-          :master_timeout,
-          :context ].freeze)
+        _id = arguments.delete(:id)
+
+        _context = arguments.delete(:context)
+
+        method = Elasticsearch::API::HTTP_PUT
+        path   = if _id && _context
+                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
+                 else
+                   "_scripts/#{Utils.__listify(_id)}"
+                 end
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
     end
   end
 end

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

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -18,36 +18,41 @@
 module Elasticsearch
   module API
     module Actions
-
-      # The ranking evaluation API allows to evaluate the quality of ranked search results over a set of typical search queries.
-      #   Given this set of queries and a list of manually rated documents, the _rank_eval endpoint calculates and
-      #   returns typical information retrieval metrics like mean reciprocal rank, precision or discounted cumulative gain.
+      # Allows to evaluate the quality of ranked search results over a set of typical search queries
       #
       # @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 [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       # @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, 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] :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/current/search-rank-eval.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html
       #
-      def rank_eval(arguments={})
+      def rank_eval(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = Elasticsearch::API::HTTP_GET
-        path   = "_rank_eval"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
-        perform_request(method, path, params, body).body
-      end
+        headers = arguments.delete(:headers) || {}
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:rank_eval, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        body = arguments.delete(:body)
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_rank_eval"
+                 else
+                   "_rank_eval"
+                 end
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
     end
   end
 end