Skip to content

Workflow — Gateway generation

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
Workflow id gateway-generation · version 1 · Draft (Draft → InReview → Published → Deprecated, BC-04)
Coordinator gateway-configurator · family API & Gateway Design
Owner service WorkflowEngineService (BC-38) under Run Control (BC-03)
Starts on BlueprintValidated from BlueprintService (event)
Steps 4 · gated 0 · agents 2
Budget per run 600000 tokens · cap 60.0 USD · 240 min
Descriptor workflow-definition-v1 · schema
Status target

Generates the product's API gateway (GW-07) from the API Gateway Blueprint on the ConnectSoft API gateway template, validates it and records the output.

Authored design, Draft (D54, D57)

These definitions were authored on 2026-10-14 from the coordinator cards as design assumptions. None is published, evaluated or has run; agents are named by id as design bindings, not as tested integrations.

Definition

flowchart TD
    start(("BlueprintValidated"))
    map_routes["Map the routes"]
    scaffold_gateway["Scaffold the gateway"]
    build_and_test[["tool: Build and test"]]
    record_outputs["Record the outputs"]
    start --> map_routes
    map_routes --> scaffold_gateway
    scaffold_gateway --> build_and_test
    build_and_test --> record_outputs
    done(("WorkflowRunCompleted"))
    record_outputs --> done
    classDef gated stroke:#B45309,stroke-width:2px
Hold "Alt" / "Option" to enable pan & zoom

Shapes: rectangle = agent attempt · double rectangle = tool call · stadium = human decision · diamond = condition evaluated by the engine · parallelogram = fan-out or join · circle = timer · cylinder = sub-workflow · flag = compensation. A thick amber border marks a gated step.

Steps

# Step Kind Runs Gate Class Depends on Retry Timeout Compensation What it does
1 Map the routes
map-routes		 agent api-designer none read — exponential ×2 PT30M — Routes, policies, rate limits and auth per operation from the blueprint and the contracts.
2 Scaffold the gateway
scaffold-gateway		 agent api-gateway-generator none sandbox map-routes exponential ×2 PT30M — Runs the API gateway template with the route map in the sandbox.
3 Build and test
build-and-test		 tool build-and-test none sandbox scaffold-gateway fixed ×2 PT20M — Compiles and runs the gateway tests in the sandbox.
4 Record the outputs
record-outputs		 agent api-gateway-generator none sandbox build-and-test exponential ×2 PT30M — Records the output with template and blueprint versions.

Gates and approvals

No approval is required: every step runs in the read or sandbox class; the agents' own tool calls still carry their classes (D21). Compensation steps run in reverse order of the succeeded steps on failure after the last checkpoint; a step without a compensation leaves its sandbox output in place and the run ends Failed with the evidence (ADR-0014, recovery not replay).

Inputs, outputs and events

Direction Name Descriptor
in api-gateway-blueprint blueprint-api-gateway-v1
in api-contracts artifact-v1
out generated-outputs change-set-v1

Starts on BlueprintValidated; emits GeneratedOutputRecorded, plus the engine's WorkflowRunStarted, StepReady, StepRunStateChanged and WorkflowRunCompleted / WorkflowRunFailed and Run Control's run and attempt events (ADR-0014).

Decisions and traceability

FR: FR-11 Compatible templates and libraries through release gatesXL: XL-09 Generation yields a usable consumerADRs: ADR-0014, ADR-0024 · ADR index

Definition authored 2026-10-14 from the coordinator card gateway-configurator (D54); Draft until an evaluation gate (ADR-0021) and a review publish it as a BC-04 asset release.