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

data/lib/opensearch/api/actions/exists_source.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
-      # Returns information about whether a document source exists in an index.
-      #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @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 exists_source(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_HEAD
-        path   = "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = nil
-        perform_request(method, path, params, body, headers).body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns information about whether a document source exists in an index.
+        #
+        # @option args [String] :id *Required* Identifier of the document.
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        # @option args [Boolean, Enumerable<String>, String] :_source `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 all shards involved in the delete by query after the request completes.
+        # @option args [Enumerable<String>, String] :routing Target the specified primary shard.
+        # @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`.
+        def exists_source(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  = 'HEAD'
+          url     = Utils.build_url(_index, '_source', _id)
+
+          Utils.validate_query_params! args, EXISTS_SOURCE_QUERY_PARAMS
+          transport.perform_head_request method, url, args, body, headers
+        end
+
+        EXISTS_SOURCE_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          preference
+          realtime
+          refresh
+          routing
+          version
+          version_type
+        ]).freeze
       end
-
-      alias exists_source? exists_source
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:exists_source, %i[
-        preference
-        realtime
-        refresh
-        routing
-        _source
-        _source_excludes
-        _source_includes
-        version
-        version_type
-      ].freeze)
     end
   end
 end

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

@@ -3,97 +3,65 @@
 # 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 information about why a specific matches (or doesn't match) a query.
-      #
-      # @option arguments [String] :id The document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
-      # @option arguments [String] :analyzer The analyzer for the query string query
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
-      # @option arguments [String] :df The default field for query string query (default: _all)
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :q Query in the Lucene query string syntax
-      # @option arguments [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 [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The query definition using the Query DSL
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def explain(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)
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns information about why a specific matches (or doesn't match) a query.
+        #
+        # @option args [String] :id *Required* Defines the document ID.
+        # @option args [String] :index *Required* Index names used to limit the request. Only a single index name can be provided to this parameter.
+        # @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 from the response.
+        # @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response.
+        # @option args [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
+        # @option args [String] :analyzer Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified.
+        # @option args [String] :default_operator The default operator for query string query: `AND` or `OR`.
+        # @option args [String] :df (default: _all) Field to use as default where no field prefix is given in the query string.
+        # @option args [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [String] :q Query in the Lucene query string syntax.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [Enumerable<String>, String] :stored_fields A comma-separated list of stored fields to return in the response.
+        # @option args [Hash] :body The query definition using the Query DSL
+        def explain(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?
 
-        _index = arguments.delete(:index)
+          _id = args.delete('id')
+          _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, '_explain', _id)
 
-        path = "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          Utils.validate_query_params! args, EXPLAIN_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        EXPLAIN_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          analyze_wildcard
+          analyzer
+          default_operator
+          df
+          lenient
+          preference
+          q
+          routing
+          stored_fields
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:explain, %i[
-        analyze_wildcard
-        analyzer
-        default_operator
-        df
-        stored_fields
-        lenient
-        preference
-        q
-        routing
-        _source
-        _source_excludes
-        _source_includes
-      ].freeze)
     end
   end
 end

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

@@ -3,76 +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.
 
-module OpenSearch
-  module API
-    module Actions
-      # Returns the information about the capabilities of fields among multiple indices.
-      #
-      # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [List] :fields A comma-separated list of field names
-      # @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 [Boolean] :include_unmapped Indicates whether unmapped fields should be included in the response.
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body An index filter specified with the Query DSL
-      #
-      #
-      def field_caps(arguments = {})
-        headers = arguments.delete(:headers) || {}
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        arguments = arguments.clone
+# frozen_string_literal: true
 
-        _index = arguments.delete(:index)
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns the information about the capabilities of fields among multiple indexes.
+        #
+        # @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.
+        # @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.
+        # @option args [Enumerable<String>, String] :fields Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
+        # @option args [Boolean] :ignore_unavailable If `true`, missing or closed indexes are not included in the response.
+        # @option args [Boolean] :include_unmapped If `true`, unmapped fields are included in the response.
+        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or `_all`.
+        # @option args [Hash] :body An index filter specified with the Query DSL
+        def field_caps(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, '_field_caps')
 
-        path = if _index
-                 "#{Utils.__listify(_index)}/_field_caps"
-               else
-                 '_field_caps'
-               end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          Utils.validate_query_params! args, FIELD_CAPS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        FIELD_CAPS_QUERY_PARAMS = Set.new(%w[
+          allow_no_indices
+          expand_wildcards
+          fields
+          ignore_unavailable
+          include_unmapped
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:field_caps, %i[
-        fields
-        ignore_unavailable
-        allow_no_indices
-        expand_wildcards
-        include_unmapped
-      ].freeze)
     end
   end
 end

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

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module FlowFramework
+      module Actions
+        # Create a workflow.
+        #
+        # @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 create(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_flow_framework/workflow'
+
+          Utils.validate_query_params! args, CREATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        CREATE_QUERY_PARAMS = Set.new(%w[
+          provision
+          reprovision
+          update_fields
+          use_case
+          validation
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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
+        # Delete a workflow.
+        #
+        # @option args [String] :workflow_id *Required*
+        # @option args [Boolean] :clear_status Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false.
+        def delete(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  = 'DELETE'
+          url     = Utils.build_url('_plugins/_flow_framework/workflow', _workflow_id)
+
+          Utils.validate_query_params! args, DELETE_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers
+        end
+
+        DELETE_QUERY_PARAMS = Set.new(%w[
+          clear_status
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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
+        # Deprovision workflow's resources when you no longer need it.
+        #
+        # @option args [String] :workflow_id *Required*
+        # @option args [String] :allow_delete Required when deleting resources involves a high potential for data loss.
+        def deprovision(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, '_deprovision')
+
+          Utils.validate_query_params! args, DEPROVISION_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        DEPROVISION_QUERY_PARAMS = Set.new(%w[
+          allow_delete
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/flow_framework/get.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 FlowFramework
+      module Actions
+        # Get a workflow.
+        #
+        # @option args [String] :workflow_id *Required*
+        def get(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  = 'GET'
+          url     = Utils.build_url('_plugins/_flow_framework/workflow', _workflow_id)
+
+          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/get_status.rb

@@ -0,0 +1,41 @@
+# 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
+        # Get the provisioning deployment status until it is complete.
+        #
+        # @option args [String] :workflow_id *Required*
+        # @option args [Boolean] :all The all parameter specifies whether the response should return all fields.
+        def get_status(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  = 'GET'
+          url     = Utils.build_url('_plugins/_flow_framework/workflow', _workflow_id, '_status')
+
+          Utils.validate_query_params! args, GET_STATUS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_STATUS_QUERY_PARAMS = Set.new(%w[
+          all
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/flow_framework/get_steps.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 FlowFramework
+      module Actions
+        # Get a list of workflow steps.
+        #
+        # @option args [String] :workflow_step The name of the step to retrieve.
+        def get_steps(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_flow_framework/workflow/_steps'
+
+          Utils.validate_query_params! args, GET_STEPS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_STEPS_QUERY_PARAMS = Set.new(%w[
+          workflow_step
+        ]).freeze
+      end
+    end
+  end
+end