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

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

@@ -3,75 +3,46 @@
 # 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
-      # Allows to evaluate the quality of ranked search results over a set of typical search queries
-      # This functionality is Experimental and may be changed or removed
-      # completely in a future release. OpenSearch will take a best effort approach
-      # to fix any issues, but experimental features are not subject to the
-      # support SLA of official GA features.
-      #
-      # @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 [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] :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*)
-      #
-      #
-      def rank_eval(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+    module Root
+      module Actions
+        # Allows to evaluate the quality of ranked search results over a set of typical search queries.
+        #
+        # @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 Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+        # @option args [Boolean] :ignore_unavailable If `true`, missing or closed indexes are not included in the response.
+        # @option args [String] :search_type Search operation type
+        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`.
+        # @option args [Hash] :body *Required* The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
+        def rank_eval(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-        headers = arguments.delete(:headers) || {}
+          _index = args.delete('index')
 
-        arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_rank_eval')
 
-        _index = arguments.delete(:index)
+          Utils.validate_query_params! args, RANK_EVAL_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_rank_eval"
-                 else
-                   '_rank_eval'
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        RANK_EVAL_QUERY_PARAMS = Set.new(%w[
+          allow_no_indices
+          expand_wildcards
+          ignore_unavailable
+          search_type
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:rank_eval, %i[
-        ignore_unavailable
-        allow_no_indices
-        expand_wildcards
-        search_type
-      ].freeze)
     end
   end
 end

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

@@ -3,74 +3,53 @@
 # 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
-      # Allows to copy documents from one index to another, optionally filtering the source
-      # documents by a query, changing the destination index settings, or fetching the
-      # documents from a remote cluster.
-      #
-      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
-      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
-      # @option arguments [Time] :scroll Control how long to keep the search context alive
-      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
-      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
-      #
-      #
-      def reindex(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+    module Root
+      module Actions
+        # Allows to copy documents from one index to another, optionally filtering the source
+        # documents by a query, changing the destination index settings, or fetching the
+        # documents from a remote cluster.
+        #
+        # @option args [Integer] :max_docs Maximum number of documents to process. By default, all documents.
+        # @option args [Boolean, String] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.
+        # @option args [Float] :requests_per_second (default: 0) The throttle for this request in sub-requests per second. Defaults to no throttle.
+        # @option args [String] :scroll Specifies how long a consistent view of the index should be maintained for scrolled search.
+        # @option args [Float, String] :slices The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
+        # @option args [String] :timeout Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
+        # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+        # @option args [Boolean] :wait_for_completion (default: true) If `true`, the request blocks until the operation is complete.
+        # @option args [Hash] :body *Required* The search definition using the Query DSL and the prototype for the index request.
+        def reindex(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-        headers = arguments.delete(:headers) || {}
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_reindex'
 
-        arguments = arguments.clone
+          Utils.validate_query_params! args, REINDEX_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::API::HTTP_POST
-        path   = '_reindex'
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        REINDEX_QUERY_PARAMS = Set.new(%w[
+          max_docs
+          refresh
+          requests_per_second
+          scroll
+          slices
+          timeout
+          wait_for_active_shards
+          wait_for_completion
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:reindex, %i[
-        refresh
-        timeout
-        wait_for_active_shards
-        wait_for_completion
-        requests_per_second
-        scroll
-        slices
-        max_docs
-      ].freeze)
     end
   end
 end

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

@@ -3,60 +3,39 @@
 # 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
-      # Changes the number of requests per second for a particular Reindex operation.
-      #
-      # @option arguments [String] :task_id The task id to rethrottle
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
-      # @option arguments [Hash] :headers Custom HTTP headers
-      #
-      #
-      def reindex_rethrottle(arguments = {})
-        raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+    module Root
+      module Actions
+        # Changes the number of requests per second for a particular Reindex operation.
+        #
+        # @option args [String] :task_id *Required* Identifier for the task.
+        # @option args [Float] :requests_per_second The throttle for this request in sub-requests per second.
+        def reindex_rethrottle(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'task_id' missing" if args['task_id'].nil?
 
-        headers = arguments.delete(:headers) || {}
+          _task_id = args.delete('task_id')
 
-        arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_reindex', _task_id, '_rethrottle')
 
-        _task_id = arguments.delete(:task_id)
+          Utils.validate_query_params! args, REINDEX_RETHROTTLE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::API::HTTP_POST
-        path   = "_reindex/#{Utils.__listify(_task_id)}/_rethrottle"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        REINDEX_RETHROTTLE_QUERY_PARAMS = Set.new(%w[
+          requests_per_second
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:reindex_rethrottle, [
-        :requests_per_second
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/remote_store/restore.rb

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# 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
 
@@ -13,30 +13,28 @@ module OpenSearch
   module API
     module RemoteStore
       module Actions
-        RESTORE_QUERY_PARAMS = Set.new(%i[
-          cluster_manager_timeout
-          wait_for_completion
-        ]).freeze
-
         # Restores from remote store.
         #
-        # @option arguments [Time] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning.
-        # @option arguments [Hash] :body *Required* Comma-separated list of index IDs
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup]
-        def restore(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning.
+        # @option args [Hash] :body *Required* Comma-separated list of index IDs
+        def restore(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_remotestore', '_restore'
-          method  = OpenSearch::API::HTTP_POST
-          params  = Utils.__validate_and_extract_params arguments, RESTORE_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_remotestore/_restore'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args, RESTORE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
+
+        RESTORE_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+          wait_for_completion
+        ]).freeze
       end
     end
   end

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

@@ -3,59 +3,32 @@
 # 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
-      # Allows to use the Mustache language to pre-render a search definition.
-      #
-      # @option arguments [String] :id The id of the stored search template
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The search definition template and its params
-      #
-      #
-      def render_search_template(arguments = {})
-        headers = arguments.delete(:headers) || {}
-
-        arguments = arguments.clone
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        _id = arguments.delete(:id)
+# frozen_string_literal: true
 
-        method = if arguments[:body]
-                   OpenSearch::API::HTTP_POST
-                 else
-                   OpenSearch::API::HTTP_GET
-                 end
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Allows to use the Mustache language to pre-render a search definition.
+        #
+        # @option args [String] :id ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required.
+        # @option args [Hash] :body The search definition template and its parameters.
+        def render_search_template(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _id = args.delete('id')
 
-        path = if _id
-                 "_render/template/#{Utils.__listify(_id)}"
-               else
-                 '_render/template'
-               end
-        params = {}
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url('_render/template', _id)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
       end
     end
   end

data/lib/opensearch/api/actions/replication/autofollow_stats.rb

@@ -0,0 +1,31 @@
+# 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 Replication
+      module Actions
+        # Gets information about auto-follow activity and any replication rules configured on the specified cluster.
+        #
+        def autofollow_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_replication/autofollow_stats'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/replication/create_replication_rule.rb

@@ -0,0 +1,34 @@
+# 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 Replication
+      module Actions
+        # Automatically starts replication on indexes matching a specified pattern.
+        #
+        # @option args [Hash] :body *Required*
+        def create_replication_rule(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_replication/_autofollow'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/replication/delete_replication_rule.rb

@@ -0,0 +1,36 @@
+# 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 Replication
+      module Actions
+        # Deletes the specified replication rule.
+        #
+        # @option args [Hash] :body *Required*
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_replication_rule(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_plugins/_replication/_autofollow'
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/replication/follower_stats.rb

@@ -0,0 +1,31 @@
+# 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 Replication
+      module Actions
+        # Gets information about follower (syncing) indexes on a specified cluster.
+        #
+        def follower_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_replication/follower_stats'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/replication/leader_stats.rb

@@ -0,0 +1,31 @@
+# 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 Replication
+      module Actions
+        # Gets information about replicated leader indexes on a specified cluster.
+        #
+        def leader_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_replication/leader_stats'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end