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

data/lib/opensearch/api/actions/flow_framework/provision.rb

@@ -0,0 +1,37 @@
+# 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 FlowFramework
+      module Actions
+        # Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true.
+        #
+        # @option args [String] :workflow_id *Required*
+        # @option args [Hash] :body Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body. For example, if you specified a credential field in the template as `openai_key: '$'`, you can pass `openai_key` as a query parameter or in the request body.
+        def provision(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'workflow_id' missing" if args['workflow_id'].nil?
+
+          _workflow_id = args.delete('workflow_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_flow_framework/workflow', _workflow_id, '_provision')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/flow_framework/search.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 FlowFramework
+      module Actions
+        # Search for workflows by using a query matching a field.
+        #
+        # @option args [Hash] :body *Required*
+        def search(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  = body ? 'POST' : 'GET'
+          url     = '_plugins/_flow_framework/workflow/_search'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/flow_framework/search_state.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 FlowFramework
+      module Actions
+        # Search for workflows by using a query matching a field.
+        #
+        # @option args [Hash] :body *Required*
+        def search_state(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  = body ? 'POST' : 'GET'
+          url     = '_plugins/_flow_framework/workflow/state/_search'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/flow_framework/update.rb

@@ -0,0 +1,50 @@
+# 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 FlowFramework
+      module Actions
+        # Update a workflow. You can only update a complete workflow if it has not yet been provisioned.
+        #
+        # @option args [String] :workflow_id *Required*
+        # @option args [Boolean] :provision Provision the workflow as part of the request.
+        # @option args [Boolean] :reprovision
+        # @option args [Boolean] :update_fields Update only the fields included in the request body.
+        # @option args [String] :use_case To use a workflow template, specify it in the `use_case` query parameter when creating a workflow.
+        # @option args [String] :validation (default: all) Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all.
+        # @option args [Hash] :body
+        def update(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'workflow_id' missing" if args['workflow_id'].nil?
+
+          _workflow_id = args.delete('workflow_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_flow_framework/workflow', _workflow_id)
+
+          Utils.validate_query_params! args, UPDATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        UPDATE_QUERY_PARAMS = Set.new(%w[
+          provision
+          reprovision
+          update_fields
+          use_case
+          validation
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -3,91 +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 a document.
-      #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
-      # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
-      # @option arguments [String] :routing Specific routing value
-      # @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] :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 get(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_GET
-        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
+        # Returns a document.
+        #
+        # @option args [String] :id *Required* Unique identifier of the document.
+        # @option args [String] :index *Required* Name of the index that contains the document.
+        # @option args [Boolean, Enumerable<String>, String] :_source Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
+        # @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude in the response.
+        # @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time.
+        # @option args [Boolean, String] :refresh If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes.
+        # @option args [Enumerable<String>, String] :routing Target the specified primary shard.
+        # @option args [Enumerable<String>, String] :stored_fields 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.
+        # @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: `internal`, `external`, `external_gte`.
+        def get(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')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url(_index, '_doc', _id)
+
+          Utils.validate_query_params! args, GET_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
-      end
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:get, %i[
-        stored_fields
-        preference
-        realtime
-        refresh
-        routing
-        _source
-        _source_excludes
-        _source_includes
-        version
-        version_type
-      ].freeze)
+        GET_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          preference
+          realtime
+          refresh
+          routing
+          stored_fields
+          version
+          version_type
+        ]).freeze
+      end
     end
   end
 end

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

@@ -3,24 +3,29 @@
 # 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
-      # Gets all PITs.
-      def get_all_pits(arguments = {})
-        method = OpenSearch::API::HTTP_GET
-        path = '_search/point_in_time/_all'
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body = nil
+    module Root
+      module Actions
+        # Lists all active point in time searches.
+        #
+        def get_all_pits(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_search/point_in_time/_all'
 
-        perform_request(method, path, params, body).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
       end
-
-      ParamsRegistry.register(:get_all_pits, [].freeze)
     end
   end
 end

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

@@ -3,62 +3,41 @@
 # 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 a script.
-      #
-      # @option arguments [String] :id Script ID
-      # @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
-      #
-      #
-      def get_script(arguments = {})
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+    module Root
+      module Actions
+        # Returns a script.
+        #
+        # @option args [String] :id *Required* Identifier for the stored script or search template.
+        # @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 master
+        def get_script(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
 
-        headers = arguments.delete(:headers) || {}
+          _id = args.delete('id')
 
-        arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_scripts', _id)
 
-        _id = arguments.delete(:id)
+          Utils.validate_query_params! args, GET_SCRIPT_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::API::HTTP_GET
-        path   = "_scripts/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = nil
-        perform_request(method, path, params, body, headers).body
+        GET_SCRIPT_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+          master_timeout
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:get_script, %i[
-        master_timeout
-        cluster_manager_timeout
-      ].freeze)
     end
   end
 end

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

@@ -3,50 +3,28 @@
 # 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 all script contexts.
-      # 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 [Hash] :headers Custom HTTP headers
-      #
-      #
-      def get_script_context(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
 
-        method = OpenSearch::API::HTTP_GET
-        path   = '_script_context'
-        params = {}
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns all script contexts.
+        #
+        def get_script_context(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_script_context'
 
-        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
   end

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

@@ -3,50 +3,28 @@
 # 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 available script types, languages and contexts
-      # 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 [Hash] :headers Custom HTTP headers
-      #
-      #
-      def get_script_languages(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
 
-        method = OpenSearch::API::HTTP_GET
-        path   = '_script_language'
-        params = {}
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns available script types, languages and contexts.
+        #
+        def get_script_languages(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_script_language'
 
-        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
   end