opensearch-ruby 3.4.0 → 4.0.0.pre.beta.1

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

@@ -3,159 +3,128 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 OpenSearch
-  module API
-    module Actions
-      # Returns results matching a query.
-      #
-      # @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] :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 [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
-      # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
-      # @option arguments [Number] :from Starting offset (default: 0)
-      # @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 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
-      # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_pipeline Customizable sequence of processing stages applied to search queries.
-      # @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
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
-      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
-      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
-      # @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
-      # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
-      # @option arguments [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
-      # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
-      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
-      # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
-      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
-      # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
-      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
-      # @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.
-      # @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
-      # @option arguments [String] :min_compatible_shard_node The minimum compatible version that all shards involved in search should have for this request to be successful
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The search definition using the Query DSL
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def search(arguments = {})
-        headers = arguments.delete(:headers) || {}
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        arguments = arguments.clone
+# frozen_string_literal: true
 
-        _index = arguments.delete(:index)
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns results matching a query.
+        #
+        # @option args [Boolean, Enumerable<String>, String] :_source Indicates which source fields are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: `true` to return the entire document source; `false` to not return the document source; `<string>` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns).
+        # @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.
+        # @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.
+        # @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
+        # @option args [Boolean] :allow_partial_search_results (default: true) If `true`, returns partial results if there are shard request timeouts or shard failures. If `false`, returns an error with no partial results.
+        # @option args [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified.
+        # @option args [String] :analyzer Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.
+        # @option args [Integer] :batched_reduce_size (default: 512) The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
+        # @option args [String] :cancel_after_time_interval The time after which the search request will be canceled. Request-level parameter takes precedence over `cancel_after_time_interval` cluster setting.
+        # @option args [Boolean] :ccs_minimize_roundtrips (default: true) If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.
+        # @option args [String] :default_operator The default operator for query string query: AND or OR. This parameter can only be used when the `q` query string parameter is specified.
+        # @option args [String] :df Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.
+        # @option args [Enumerable<String>, String] :docvalue_fields A comma-separated list of fields to return as the docvalue representation for each hit.
+        # @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.
+        # @option args [Boolean] :explain If `true`, returns detailed information about score computation as part of a hit.
+        # @option args [Integer] :from (default: 0) Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.
+        # @option args [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indexes will be ignored when frozen.
+        # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
+        # @option args [Boolean] :include_named_queries_score Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)
+        # @option args [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can only be used when the `q` query string parameter is specified.
+        # @option args [Integer] :max_concurrent_shard_requests (default: 5) Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
+        # @option args [Boolean] :phase_took Indicates whether to return phase-level `took` time values in the response.
+        # @option args [Integer] :pre_filter_shard_size Defines 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: the request targets more than 128 shards; the request targets one or more read-only index; the primary sort of the query targets an indexed field.
+        # @option args [String] :preference (default: random) Nodes and shards used for the search. By default, OpenSearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: `_only_local` to run the search only on shards on the local node; `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; `_shards:<shard>,<shard>` to run the search only on the specified shards; `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.
+        # @option args [String] :q Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing.
+        # @option args [Boolean] :request_cache If `true`, the caching of search results is enabled for requests where `size` is `0`. Defaults to index level settings.
+        # @option args [Boolean] :rest_total_hits_as_int Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :scroll Period to retain the search context for scrolling. See Scroll search results. By default, this value cannot exceed `1d` (24 hours). You can change this limit using the `search.max_keep_alive` cluster-level setting.
+        # @option args [String] :search_pipeline Customizable sequence of processing stages applied to search queries.
+        # @option args [String] :search_type How distributed term frequencies are calculated for relevance scoring.
+        # @option args [Boolean] :seq_no_primary_term If `true`, returns sequence number and primary term of the last modification of each hit.
+        # @option args [Integer] :size (default: 10) Defines the number of hits to return. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.
+        # @option args [Enumerable<String>, String] :sort A comma-separated list of <field>:<direction> pairs.
+        # @option args [Enumerable<String>] :stats Specific `tag` of the request for logging and statistical purposes.
+        # @option args [Enumerable<String>, String] :stored_fields A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.
+        # @option args [String] :suggest_field Specifies which field to use for suggestions.
+        # @option args [String] :suggest_mode Specifies the suggest mode. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
+        # @option args [Integer] :suggest_size Number of suggestions to return. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
+        # @option args [String] :suggest_text The source text for which the suggestions should be returned. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
+        # @option args [Integer] :terminate_after Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early.
+        # @option args [String] :timeout Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Boolean] :track_scores If `true`, calculate and return document scores, even if the scores are not used for sorting.
+        # @option args [Boolean, Integer] :track_total_hits Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.
+        # @option args [Boolean] :typed_keys If `true`, aggregation and suggester names are be prefixed by their respective types in the response.
+        # @option args [Boolean] :version If `true`, returns document version as part of a hit.
+        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
+        # @option args [Hash] :body The search definition using the Query DSL
+        def search(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
 
-        method = if arguments[:body]
-                   OpenSearch::API::HTTP_POST
-                 else
-                   OpenSearch::API::HTTP_GET
-                 end
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_search')
 
-        path = if _index
-                 "#{Utils.__listify(_index)}/_search"
-               else
-                 '_search'
-               end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          Utils.validate_query_params! args, SEARCH_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        SEARCH_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          allow_no_indices
+          allow_partial_search_results
+          analyze_wildcard
+          analyzer
+          batched_reduce_size
+          cancel_after_time_interval
+          ccs_minimize_roundtrips
+          default_operator
+          df
+          docvalue_fields
+          expand_wildcards
+          explain
+          from
+          ignore_throttled
+          ignore_unavailable
+          include_named_queries_score
+          lenient
+          max_concurrent_shard_requests
+          phase_took
+          pre_filter_shard_size
+          preference
+          q
+          request_cache
+          rest_total_hits_as_int
+          routing
+          scroll
+          search_pipeline
+          search_type
+          seq_no_primary_term
+          size
+          sort
+          stats
+          stored_fields
+          suggest_field
+          suggest_mode
+          suggest_size
+          suggest_text
+          terminate_after
+          timeout
+          track_scores
+          track_total_hits
+          typed_keys
+          version
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search, %i[
-        analyzer
-        analyze_wildcard
-        ccs_minimize_roundtrips
-        default_operator
-        df
-        explain
-        stored_fields
-        docvalue_fields
-        from
-        ignore_unavailable
-        ignore_throttled
-        allow_no_indices
-        expand_wildcards
-        lenient
-        preference
-        q
-        routing
-        scroll
-        search_pipeline
-        search_type
-        size
-        sort
-        _source
-        _source_excludes
-        _source_includes
-        terminate_after
-        stats
-        suggest_field
-        suggest_mode
-        suggest_size
-        suggest_text
-        timeout
-        track_scores
-        track_total_hits
-        allow_partial_search_results
-        typed_keys
-        version
-        seq_no_primary_term
-        request_cache
-        batched_reduce_size
-        max_concurrent_shard_requests
-        pre_filter_shard_size
-        rest_total_hits_as_int
-        min_compatible_shard_node
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/search_pipeline/delete.rb

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module SearchPipeline
+      module Actions
+        # Deletes the specified search pipeline.
+        #
+        # @option args [String] :id *Required* Pipeline ID.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :timeout Operation timeout.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_search/pipeline', _id)
+
+          Utils.validate_query_params! args, DELETE_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+
+        DELETE_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/search_pipeline/get.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module SearchPipeline
+      module Actions
+        # Retrieves information about a specified search pipeline.
+        #
+        # @option args [String] :cluster_manager_timeout operation timeout for connection to cluster-manager node.
+        # @option args [String] :id Comma-separated list of search pipeline ids. Wildcards supported.
+        def get(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_search/pipeline', _id)
+
+          Utils.validate_query_params! args, GET_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/search_pipeline/put.rb

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module SearchPipeline
+      module Actions
+        # Creates or replaces the specified search pipeline.
+        #
+        # @option args [String] :id *Required* Pipeline ID.
+        # @option args [String] :cluster_manager_timeout operation timeout for connection to cluster-manager node.
+        # @option args [String] :timeout Operation timeout.
+        # @option args [Hash] :body *Required*
+        def put(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_search/pipeline', _id)
+
+          Utils.validate_query_params! args, PUT_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        PUT_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/search_shards.rb

@@ -3,72 +3,48 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
-    module Actions
-      # Returns information about the indices and shards that a search request would be executed against.
-      #
-      # @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 cluster_manager 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, hidden, none, all)
-      # @option arguments [Hash] :headers Custom HTTP headers
-      #
-      #
-      def search_shards(arguments = {})
-        headers = arguments.delete(:headers) || {}
+    module Root
+      module Actions
+        # Returns information about the indexes and shards that a search request would be executed against.
+        #
+        # @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
+        # @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+        # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
+        # @option args [Boolean] :local If `true`, the request retrieves information from the local node only.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [Enumerable<String>, String] :index Returns the indexes and shards that a search request would be executed against.
+        # @option args [Hash] :body Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
+        def search_shards(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
 
-        arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_search_shards')
 
-        _index = arguments.delete(:index)
+          Utils.validate_query_params! args, SEARCH_SHARDS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::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
-        perform_request(method, path, params, body, headers).body
+        SEARCH_SHARDS_QUERY_PARAMS = Set.new(%w[
+          allow_no_indices
+          expand_wildcards
+          ignore_unavailable
+          local
+          preference
+          routing
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search_shards, %i[
-        preference
-        routing
-        local
-        ignore_unavailable
-        allow_no_indices
-        expand_wildcards
-      ].freeze)
     end
   end
 end