composition.import

Import virtual-workflow definitions from a GitHub repo (drafts; activate per manifest)

Bulk-import a repo's definitions via a GitHub connection (drafts; --release activates).

Overview

Property	Value
Workflow type	Atomic
Library	App-composition
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
github_repository_uuid	uuid	No	—	Synced GitHubRepository uuid (one of two repo-identity inputs)
github_connection_uuid	uuid	No	—	GitHub CloudConnection uuid (with repository)
repository	string	No	—	'owner/name' (required with github_connection_uuid)
ref	string	No	—	Branch/tag/SHA (default: repo default)
manifest	dict	Yes	—	{definitions_path, definitions?, active: {name: semver}}
activate	boolean	No	False	Activate versions named in manifest.active (the --release flag)
created_by_uuid	uuid	No	—	—

Output Schema

Field	Type	Required	Default	Description
imported	list	Yes	—	Per-definition
activated	list	Yes	—	Names activated this import
repo	dict	Yes	—
summary	dict	Yes	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Apply composition change
completed	No	Yes	Yes	—	Done
failed	No	Yes	No	—	Failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

API Usage

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

{
  "workflow_type": "composition.import",
  "initial_data": {
    "organization_uuid": "value",
    "manifest": "value"
  }
}