Skip to content
Proud to collaborate with Microsoft for Startups

composition.plan ​

Diff desired composition definitions against saved state (read-only plan)

Diff desired definitions against saved compositions; report create/update/no_op/promote.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-composition
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
definitionslistYes—List of {name, definition} desired-state entries
activedictNo—Desired active map {name: semver} from the manifest

Output Schema ​

FieldTypeRequiredDefaultDescription
planlistYes—Per-definition
summarydictYes—Counts keyed by action (create/update/no_op/promote/error)
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.plan",
  "initial_data": {
    "organization_uuid": "value",
    "definitions": "value"
  }
}