Cuerdo.Arazzo (cuerdo v0.4.0)

Copy Markdown

Arazzo workflows runner and validation.

Summary

Functions

run_workflow(workflow_inputs, workflow_id, context)

@spec run_workflow(any(), String.t(), map() | Cuerdo.Arazzo.Context.t()) ::
  {:ok, Cuerdo.Arazzo.Context.t()} | {:error, Cuerdo.Errors.ExecutionError.t()}

run_workflow(workflow_inputs, workflow_id, document, opts \\ [])

@spec run_workflow(any(), String.t(), map(), Keyword.t()) ::
  {:ok, Cuerdo.Arazzo.Context.t()} | {:error, Exception.t()}

Runs the workflowId with the given inputs from the Arazzo document.

Returns {:ok, context} on success with each step requests and responses, or an {:error, reason}.

Options

  • :resolver - The JSON Schema resolver to use for validating workflow inputs and request/response schemas. See JSV Resolvers