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

data/lib/opensearch/api/actions/ml/upload_model.rb

@@ -0,0 +1,32 @@
+# 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 Ml
+      module Actions
+        # Registers a model.
+        #
+        # @option args [Hash] :body
+        def upload_model(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ml/models/_upload'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -3,103 +3,52 @@
 # 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 execute several search operations in one request.
-      #
-      # @option arguments [List] :index A comma-separated list of index names to use as default
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
-      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-      # @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 [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. 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 [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 [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def msearch(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
-        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)
-
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_msearch"
-                 else
-                   '_msearch'
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        if body.is_a?(Array) && body.any? { |d| d.key? :search }
-          payload = body
-                    .each_with_object([]) do |item, sum|
-                      meta = item
-                      data = meta.delete(:search)
-
-                      sum << meta
-                      sum << data
-                    end
-          payload = payload.map { |item| OpenSearch::API.serializer.dump(item) }
-          payload << '' unless payload.empty?
-          payload = payload.join("\n")
-        elsif body.is_a?(Array)
-          payload = body.map { |d| d.is_a?(String) ? d : OpenSearch::API.serializer.dump(d) }
-          payload << '' unless payload.empty?
-          payload = payload.join("\n")
-        else
-          payload = body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Allows to execute several search operations in one request.
+        #
+        # @option args [Boolean] :ccs_minimize_roundtrips (default: true) If `true`, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests.
+        # @option args [Integer] :max_concurrent_searches Maximum number of concurrent searches the multi search API can execute.
+        # @option args [Integer] :max_concurrent_shard_requests (default: 5) Maximum number of concurrent shard requests that each sub-search request executes per node.
+        # @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 i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
+        # @option args [Boolean] :rest_total_hits_as_int If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object.
+        # @option args [String] :search_type Indicates whether global term and document frequencies should be used when scoring returned documents.
+        # @option args [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.
+        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and index aliases to search.
+        # @option args [Enumerable<Hash>] :body *Required* The request definitions (metadata-search request definition pairs), separated by newlines
+        def msearch(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _index = args.delete('index')
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_msearch')
+
+          Utils.validate_query_params! args, MSEARCH_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        headers.merge!('Content-Type' => 'application/x-ndjson')
-        perform_request(method, path, params, payload, headers).body
+        MSEARCH_QUERY_PARAMS = Set.new(%w[
+          ccs_minimize_roundtrips
+          max_concurrent_searches
+          max_concurrent_shard_requests
+          pre_filter_shard_size
+          rest_total_hits_as_int
+          search_type
+          typed_keys
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:msearch, %i[
-        search_type
-        max_concurrent_searches
-        typed_keys
-        pre_filter_shard_size
-        max_concurrent_shard_requests
-        rest_total_hits_as_int
-        ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

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

@@ -3,87 +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.
-
-module OpenSearch
-  module API
-    module Actions
-      # Allows to execute several search template operations in one request.
-      #
-      # @option arguments [List] :index A comma-separated list of index names to use as default
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
-      # @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 [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def msearch_template(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        headers = arguments.delete(:headers) || {}
-
-        arguments = arguments.clone
 
-        _index = arguments.delete(:index)
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_msearch/template"
-                 else
-                   '_msearch/template'
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+# frozen_string_literal: true
 
-        body = arguments[:body]
-        if body.is_a?(Array)
-          payload = body.map { |d| d.is_a?(String) ? d : OpenSearch::API.serializer.dump(d) }
-          payload << '' unless payload.empty?
-          payload = payload.join("\n")
-        else
-          payload = body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Allows to execute several search template operations in one request.
+        #
+        # @option args [Boolean] :ccs_minimize_roundtrips (default: true) If `true`, network round-trips are minimized for cross-cluster search requests.
+        # @option args [Integer] :max_concurrent_searches Maximum number of concurrent searches the API can run.
+        # @option args [Boolean] :rest_total_hits_as_int If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object.
+        # @option args [String] :search_type The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.
+        # @option args [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types.
+        # @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 `*`.
+        # @option args [Enumerable<Hash>] :body *Required* The request definitions (metadata-search request definition pairs), separated by newlines
+        def msearch_template(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _index = args.delete('index')
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_msearch/template')
+
+          Utils.validate_query_params! args, MSEARCH_TEMPLATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        headers.merge!('Content-Type' => 'application/x-ndjson')
-        perform_request(method, path, params, payload, headers).body
+        MSEARCH_TEMPLATE_QUERY_PARAMS = Set.new(%w[
+          ccs_minimize_roundtrips
+          max_concurrent_searches
+          rest_total_hits_as_int
+          search_type
+          typed_keys
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:msearch_template, %i[
-        search_type
-        typed_keys
-        max_concurrent_searches
-        rest_total_hits_as_int
-        ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

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

@@ -3,100 +3,60 @@
 # 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 multiple termvectors in one request.
-      #
-      # @option arguments [String] :index The index in which the document resides.
-      # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
-      # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [List] :fields A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
-      # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
-      # @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
-      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def mtermvectors(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
-        ids = arguments.delete(:ids)
+# frozen_string_literal: true
 
-        _index = arguments.delete(:index)
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns multiple termvectors in one request.
+        #
+        # @option args [Boolean] :field_statistics (default: true) If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
+        # @option args [Enumerable<String>, String] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
+        # @option args [Enumerable<String>] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
+        # @option args [Boolean] :offsets (default: true) If `true`, the response includes term offsets.
+        # @option args [Boolean] :payloads (default: true) If `true`, the response includes term payloads.
+        # @option args [Boolean] :positions (default: true) If `true`, the response includes term positions.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [Boolean] :realtime (default: true) If `true`, the request is real-time as opposed to near-real-time.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [Boolean] :term_statistics If `true`, the response includes term frequency and document frequency.
+        # @option args [Integer] :version If `true`, returns the document version as part of a hit.
+        # @option args [String] :version_type Specific version type.
+        # @option args [String] :index Name of the index that contains the documents.
+        # @option args [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
+        def mtermvectors(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, '_mtermvectors')
 
-        path = if _index
-                 "#{Utils.__listify(_index)}/_mtermvectors"
-               else
-                 '_mtermvectors'
-               end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          Utils.validate_query_params! args, MTERMVECTORS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        body = if ids
-                 { ids: ids }
-               else
-                 arguments[:body]
-               end
-        perform_request(method, path, params, body, headers).body
+        MTERMVECTORS_QUERY_PARAMS = Set.new(%w[
+          field_statistics
+          fields
+          ids
+          offsets
+          payloads
+          positions
+          preference
+          realtime
+          routing
+          term_statistics
+          version
+          version_type
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:mtermvectors, %i[
-        ids
-        term_statistics
-        field_statistics
-        fields
-        offsets
-        positions
-        payloads
-        preference
-        routing
-        realtime
-        version
-        version_type
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/nodes/hot_threads.rb

@@ -3,26 +3,11 @@
 # 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
@@ -30,51 +15,34 @@ module OpenSearch
       module Actions
         # Returns information about hot threads on each node in the cluster.
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [Time] :interval The interval for the second sampling of threads
-        # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
-        # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
-        # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
-        # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        # *Deprecation notice*:
-        # The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons
-        # Deprecated since version 7.0.0
-        #
-        #
-        #
-        def hot_threads(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Enumerable<String>] :node_id Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
+        # @option args [Boolean] :ignore_idle_threads (default: true) Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.
+        # @option args [String] :interval The interval for the second sampling of threads.
+        # @option args [Integer] :snapshots (default: 10) Number of samples of thread stack trace.
+        # @option args [Integer] :threads (default: 3) Specify the number of threads to provide information for.
+        # @option args [String] :timeout Operation timeout.
+        # @option args [String] :type The type to sample.
+        def hot_threads(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
 
-          _node_id = arguments.delete(:node_id)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_nodes', _node_id, 'hot_threads')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id
-                     "_cluster/nodes/#{Utils.__listify(_node_id)}/hot_threads"
-                   else
-                     '_cluster/nodes/hot_threads'
-                   end
-          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, HOT_THREADS_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(:hot_threads, %i[
+        HOT_THREADS_QUERY_PARAMS = Set.new(%w[
+          ignore_idle_threads
           interval
           snapshots
           threads
-          ignore_idle_threads
-          type
           timeout
-        ].freeze)
+          type
+        ]).freeze
       end
     end
   end