Skip to content
Proud to collaborate with Microsoft for Startups

composition.validate ​

Validate a composition definition against the live registry (no persist)

Validate a composition definition against the live registry without saving.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-composition
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
definitiondictYes—Serializer-dialect VirtualWorkflow: top-level name plus layers; each layer has name and steps; each step has name, workflow_type, and optional input_mapping param -> {source: input
include_dry_runbooleanNoFalseAlso run the pre-activation dry-run data-flow gate
summary_onlybooleanNoFalseReturn the verdict only — passed, errors, warnings and repairs_total — with an empty repairs array. For callers that want to know whether a definition is valid without transporting the repair candidates.

Output Schema ​

FieldTypeRequiredDefaultDescription
passedbooleanYes——
errorslistYes——
warningslistYes——
repairslistYes—Machine-actionable RepairSuggestions for ambiguous/missing inputs. Bounded: read repairs_total for the full count and each repair's candidates_total for its own
repairs_totalintegerYes—How many repairs the validator produced, before bounding
dry_rundictNo—{passed, errors, evaluated} when include_dry_run was set
failure_reasonstringNo—Engine-stamped human-readable failure reason
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action method that raised
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped DAG step that failed
failed_layerstringNo—Engine-stamped DAG layer that failed
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "composition.validate",
  "initial_data": {
    "organization_uuid": "value",
    "definition": "value"
  }
}