search_shards.rb in elasticsearch-api-7.5.0.pre.pre

- old
+ new
@@ -3,47 +3,50 @@
 # See the LICENSE file in the project root for more information
 
 module Elasticsearch
   module API
     module Actions
-
-      # Returns the names of indices and shards on which a search request would be executed
+      # Returns information about the indices and shards that a search request would be executed against.
       #
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @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 [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] :local Return local information, do not retrieve the state from master node
-      #                                    (default: false)
-      # @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` 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)
+      # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+      # @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)
+
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-shards.html
       #
-      def search_shards(arguments={})
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search_shards' )
+      def search_shards(arguments = {})
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_search_shards"
+                 else
+                   "_search_shards"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
 
+        body = nil
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:search_shards, [
-          :preference,
-          :routing,
-          :local,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        :preference,
+        :routing,
+        :local,
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards
+      ].freeze)
     end
-  end
+    end
 end