Squidie.Runs.SpecPreview (squidie v0.3.2)

Copy Markdown View Source

Compatibility preview struct for runtime-authored workflow specs.

Squidie.Inspection.SpecPreview is the canonical inspection namespace. This module preserves the original Squidie.Runs.* struct for existing callers.

Summary

Types

preview_node()
t()

Functions

new(attrs)

Builds a compatibility spec preview struct.

to_map(preview)

Converts a compatibility spec preview to a plain map for JSON encoding.

Types

preview_node()

@type preview_node() :: Squidie.Inspection.SpecPreview.preview_node()

t()

@type t() :: %Squidie.Runs.SpecPreview{
  definition_version: String.t() | nil,
  errors: [map()],
  nodes: [preview_node()],
  run_id: nil,
  status: :completed | :failed | :blocked | :invalid,
  trigger: atom() | nil,
  workflow: module()
}

Functions

new(attrs)

@spec new(keyword()) :: t()

Builds a compatibility spec preview struct.

to_map(preview)

@spec to_map(t()) :: map()

Converts a compatibility spec preview to a plain map for JSON encoding.