Jidoka.Workflow.Spec (Jidoka v0.9.0)

Copy Markdown View Source

Data contract for a deterministic Jidoka workflow.

Summary

Types

t()

Functions

modes()

Returns the supported workflow definition modes.

new(attrs)

Parses workflow spec attributes into a validated spec.

new!(attrs)

Parses workflow spec attributes into a validated spec or raises.

schema()

Returns the Zoi schema for workflow specs.

Types

t()

@type t() :: %Jidoka.Workflow.Spec{
  context_refs: [any()],
  dependencies: map(),
  description: nil | nil | binary(),
  id: binary(),
  input_refs: [any()],
  input_schema: nil | nil | any(),
  metadata: map(),
  mode: :callback | :dsl,
  module: atom(),
  output: nil | nil | any(),
  parameters_schema: nil | nil | map(),
  steps: [term()]
}

Functions

modes()

@spec modes() :: [atom()]

Returns the supported workflow definition modes.

new(attrs)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

Parses workflow spec attributes into a validated spec.

new!(attrs)

@spec new!(keyword() | map()) :: t()

Parses workflow spec attributes into a validated spec or raises.

schema()

@spec schema() :: Zoi.schema()

Returns the Zoi schema for workflow specs.