[API] Updates indices.resolve_cluster - Adds timeout, name no longer a required parameter

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb

@@ -22,13 +22,14 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
+        # Resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster.
         #
         # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
-        # @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 wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression.
+        # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression.
+        # @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). Only allowed when providing an index expression.
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. (options: open, closed, hidden, none, all)
+        # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-cluster-api.html
@@ -41,8 +42,6 @@ def resolve_cluster(arguments = {})
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
@@ -51,7 +50,11 @@ def resolve_cluster(arguments = {})
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_resolve/cluster/#{Utils.__listify(_name)}"
+          path   = if _name
+                     "_resolve/cluster/#{Utils.__listify(_name)}"
+                   else
+                     '_resolve/cluster'
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

elasticsearch-api/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb

@@ -17,33 +17,38 @@
 
 require 'spec_helper'
 
-describe 'client.indices#delete_alias' do
-
+describe 'client.indices#resolve_cluster' do
   let(:expected_args) do
     [
       'GET',
-      '_resolve/cluster/foo',
+      path,
       {},
       nil,
       {},
-      { defined_params: { name: 'foo'}, endpoint: 'indices.resolve_cluster' }
+      otel
     ]
   end
 
   context 'when there is no name specified' do
     let(:client) do
       Class.new { include Elasticsearch::API }.new
     end
+    let(:path) { '_resolve/cluster' }
+    let(:otel) do
+      { endpoint: 'indices.resolve_cluster' }
+    end
 
-    it 'raises an exception' do
-      expect {
-        client.indices.resolve_cluster
-      }.to raise_exception(ArgumentError)
+    it 'performs the request' do
+      expect(client_double.indices.resolve_cluster).to be_a Elasticsearch::API::Response
     end
   end
 
-
   context 'when name is specified' do
+    let(:path) { '_resolve/cluster/foo' }
+    let(:otel) do
+      { defined_params: { name: 'foo' }, endpoint: 'indices.resolve_cluster' }
+    end
+
     it 'performs the request' do
       expect(client_double.indices.resolve_cluster(name: 'foo')).to be_a Elasticsearch::API::Response
     end