Get workflow steps

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.

OpenSearch validates workflows by using the validation template that lists the required inputs, generated outputs, and required plugins for all steps. For example, for the register_remote_model step, the validation template appears as follows:

  1. {
  2.   "register_remote_model": {
  3.     "inputs": [
  4.       "name",
  5.       "connector_id"
  6.     ],
  7.     "outputs": [
  8.       "model_id",
  9.       "register_model_status"
  10.     ],
  11.     "required_plugins": [
  12.       "opensearch-ml"
  13.     ]
  14.   }
  15. }

The Get Workflow Steps API retrieves this file.

Path and HTTP methods

  1. GET /_plugins/_flow_framework/workflow/_steps

Example request

  1. GET /_plugins/_flow_framework/workflow/_steps

copy

Example response

OpenSearch responds with the validation template containing the steps. The order of fields in the returned steps may not exactly match the original JSON but will function identically.

To retrieve the template in YAML format, specify Content-Type: application/yaml in the request header:

  1. curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/yaml'

To retrieve the template in JSON format, specify Content-Type: application/json in the request header:

  1. curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/json'