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

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

@@ -3,43 +3,47 @@
 # 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.
+
+# 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
-      # Creates a point in time.
-      #
-      # @option arguments [String] :index The name(s) of the target index(es) for the PIT. May contain a comma-separated list or a wildcard index pattern. (required)
-      # @option arguments [String] :keep_alive The amount of time to keep the PIT. (required)
-      # @option arguments [String] :preference The node or the shard used to perform the search. (default: random)
-      # @option arguments [String] :routing Specifies to route search requests to a specific shard.
-      # @option arguments [String] :expand_wildcards The type of index that can match the wildcard pattern. Supports comma-separated values. (default: open)
-      # @option arguments [String] :allow_partial_pit_creation Specifies whether to create a PIT with partial failures. (default: false)
-      def create_pit(arguments = {})
-        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'keep_alive' missing" unless arguments[:keep_alive]
+    module Root
+      module Actions
+        # Creates point in time context.
+        #
+        # @option args [Enumerable<String>] :index *Required* Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes.
+        # @option args [Boolean] :allow_partial_pit_creation Allow if point in time can be created with partial failures.
+        # @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+        # @option args [String] :keep_alive Specify the keep alive for point in time.
+        # @option args [String] :preference (default: random) Specify the node or shard the operation should be performed on.
+        # @option args [Enumerable<String>, String] :routing Comma-separated list of specific routing values.
+        def create_pit(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
 
-        arguments = arguments.clone
-        _index = arguments.delete(:index)
+          _index = args.delete('index')
 
-        method = OpenSearch::API::HTTP_POST
-        path = "#{Utils.__listify(_index)}/_search/point_in_time"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body = nil
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url(_index, '_search/point_in_time')
 
-        perform_request(method, path, params, body).body
-      end
+          Utils.validate_query_params! args, CREATE_PIT_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-      ParamsRegistry.register(:create_pit, %i[
-        keep_alive
-        preference
-        routing
-        expand_wildcards
-        allow_partial_pit_creation
-      ].freeze)
+        CREATE_PIT_QUERY_PARAMS = Set.new(%w[
+          allow_partial_pit_creation
+          expand_wildcards
+          keep_alive
+          preference
+          routing
+        ]).freeze
+      end
     end
   end
 end

data/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb

@@ -3,67 +3,47 @@
 # 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 DanglingIndices
       module Actions
-        # Deletes the specified dangling index
-        #
-        # @option arguments [String] :index_uuid The UUID of the dangling index
-        # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
-        # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
+        # Deletes the specified dangling index.
         #
-        def delete_dangling_index(arguments = {})
-          raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
+        # @option args [String] :index_uuid *Required* The UUID of the dangling index.
+        # @option args [Boolean] :accept_data_loss *Required* Must be set to true in order to delete the dangling index.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Specify timeout for connection to cluster manager.
+        # @option args [String] :timeout Explicit operation timeout.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_dangling_index(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index_uuid' missing" if args['index_uuid'].nil?
+          raise ArgumentError, "Required argument 'accept_data_loss' missing" if args['accept_data_loss'].nil?
 
-          headers = arguments.delete(:headers) || {}
+          _index_uuid = args.delete('index_uuid')
 
-          arguments = arguments.clone
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_dangling', _index_uuid)
 
-          _index_uuid = arguments.delete(:index_uuid)
-
-          method = OpenSearch::API::HTTP_DELETE
-          path   = "_dangling/#{Utils.__listify(_index_uuid)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, DELETE_DANGLING_INDEX_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_dangling_index, %i[
+        DELETE_DANGLING_INDEX_QUERY_PARAMS = Set.new(%w[
           accept_data_loss
-          timeout
-          master_timeout
           cluster_manager_timeout
-        ].freeze)
+          master_timeout
+          timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb

@@ -3,66 +3,45 @@
 # 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 DanglingIndices
       module Actions
-        # Imports the specified dangling index
-        #
-        # @option arguments [String] :index_uuid The UUID of the dangling index
-        # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
-        # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
-        # @option arguments [Hash] :headers Custom HTTP headers
+        # Imports the specified dangling index.
         #
-        def import_dangling_index(arguments = {})
-          raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
+        # @option args [String] :index_uuid *Required* The UUID of the dangling index.
+        # @option args [Boolean] :accept_data_loss *Required* Must be set to true in order to import the dangling index.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Specify timeout for connection to cluster manager.
+        # @option args [String] :timeout Explicit operation timeout.
+        def import_dangling_index(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index_uuid' missing" if args['index_uuid'].nil?
+          raise ArgumentError, "Required argument 'accept_data_loss' missing" if args['accept_data_loss'].nil?
 
-          headers = arguments.delete(:headers) || {}
+          _index_uuid = args.delete('index_uuid')
 
-          arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_dangling', _index_uuid)
 
-          _index_uuid = arguments.delete(:index_uuid)
-
-          method = OpenSearch::API::HTTP_POST
-          path   = "_dangling/#{Utils.__listify(_index_uuid)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, IMPORT_DANGLING_INDEX_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:import_dangling_index, %i[
+        IMPORT_DANGLING_INDEX_QUERY_PARAMS = Set.new(%w[
           accept_data_loss
-          timeout
-          master_timeout
           cluster_manager_timeout
-        ].freeze)
+          master_timeout
+          timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/dangling_indices/list_dangling_indices.rb

@@ -3,47 +3,27 @@
 # 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 DanglingIndices
       module Actions
-        # Returns all dangling indices.
-        #
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
+        # Returns all dangling indexes.
         #
-        def list_dangling_indices(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          method = OpenSearch::API::HTTP_GET
-          path   = '_dangling'
-          params = {}
+        def list_dangling_indices(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_dangling'
 
-          body = nil
-          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

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

@@ -3,87 +3,58 @@
 # 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
-      # Removes a document from the index.
-      #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete 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 [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number
-      # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
-      # @option arguments [Hash] :headers Custom HTTP headers
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def delete(arguments = {})
-        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        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
 
-        _id = arguments.delete(:id)
-
-        _index = arguments.delete(:index)
-
-        method = OpenSearch::API::HTTP_DELETE
-        path   = "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = nil
-        if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-        else
-          perform_request(method, path, params, body, headers).body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Removes a document from the index.
+        #
+        # @option args [String] :id *Required* Unique identifier for the document.
+        # @option args [String] :index *Required* Name of the target index.
+        # @option args [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+        # @option args [Boolean, String] :refresh If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :timeout Period to wait for active shards.
+        # @option args [Integer] :version Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.
+        # @option args [String] :version_type Specific version type: `external`, `external_gte`.
+        # @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 [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?
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _id = args.delete('id')
+          _index = args.delete('index')
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url(_index, '_doc', _id)
+
+          Utils.validate_query_params! args, DELETE_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
         end
-      end
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:delete, %i[
-        wait_for_active_shards
-        refresh
-        routing
-        timeout
-        if_seq_no
-        if_primary_term
-        version
-        version_type
-      ].freeze)
+        DELETE_QUERY_PARAMS = Set.new(%w[
+          if_primary_term
+          if_seq_no
+          refresh
+          routing
+          timeout
+          version
+          version_type
+          wait_for_active_shards
+        ]).freeze
+      end
     end
   end
 end

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

@@ -3,24 +3,31 @@
 # 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.
+
+# 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
-      # Deletes all PITs.
-      def delete_all_pits(arguments = {})
-        method = OpenSearch::API::HTTP_DELETE
-        path = '_search/point_in_time/_all'
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body = nil
+    module Root
+      module Actions
+        # Deletes all active point in time searches.
+        #
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_all_pits(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_search/point_in_time/_all'
 
-        perform_request(method, path, params, body).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
       end
-
-      ParamsRegistry.register(:delete_all_pits, [].freeze)
     end
   end
 end