{
"id": "workflow:api-design-review",
"_kind": "Workflow",
"_file": "domain/workflows/workflows-development.yaml",
"_cluster": "domain",
"attributes": {
"displayName": "API Design Review",
"description": "Structured cross-team review triggered whenever a team proposes a new public or\ninternal API contract. The proposing team documents endpoints, data schemas, error\ncodes, and versioning strategy in an API design document or OpenAPI spec. A review\npanel of architects, backend engineers, and consumer-team leads evaluates the design\nfor consistency, backward compatibility, security, and developer experience. Feedback\nis incorporated and a second round of review may follow. Final approval gates\nimplementation work. The workflow ensures APIs are coherent, stable, and easy to\nconsume across organizational boundaries.\n",
"workflowKind": "development",
"triggerType": "on-demand",
"typicalCadence": "per-api-change",
"complexity": "moderate"
},
"outgoingEdges": [
{
"from": "workflow:api-design-review",
"to": "role:architect",
"kind": "involves_role"
},
{
"from": "workflow:api-design-review",
"to": "role:backend-engineer",
"kind": "involves_role"
},
{
"from": "workflow:api-design-review",
"to": "role:tech-lead",
"kind": "involves_role"
},
{
"from": "workflow:api-design-review",
"to": "role:solutions-architect",
"kind": "involves_role"
},
{
"from": "workflow:api-design-review",
"to": "role:technical-writer",
"kind": "involves_role"
},
{
"from": "workflow:api-design-review",
"to": "domain:software-engineering",
"kind": "applies_to_domain"
},
{
"from": "workflow:api-design-review",
"to": "domain:web-development",
"kind": "applies_to_domain"
},
{
"from": "workflow:api-design-review",
"to": "responsibility:architecture-decision",
"kind": "triggers_responsibility"
},
{
"from": "workflow:api-design-review",
"to": "responsibility:documentation",
"kind": "triggers_responsibility"
},
{
"from": "workflow:api-design-review",
"to": "responsibility:stakeholder-communication",
"kind": "triggers_responsibility"
},
{
"from": "workflow:api-design-review",
"to": "role:staff-engineer",
"kind": "involves_role",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "role:code-reviewer",
"kind": "involves_role",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "role:tech-lead",
"kind": "involves_role",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "skill-area:graphql-schema-design",
"kind": "requires_skill_area",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "skill-area:rate-limiting",
"kind": "requires_skill_area",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "domain:software-engineering",
"kind": "applies_to_domain",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "domain:web-development",
"kind": "applies_to_domain",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "responsibility:review-architecture-changes",
"kind": "triggers_responsibility",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "responsibility:adr-curation",
"kind": "triggers_responsibility",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "org-unit:engineering",
"kind": "performed_by_org_unit",
"attributes": {}
},
{
"from": "workflow:api-design-review",
"to": "org-unit:architecture-guild",
"kind": "performed_by_org_unit",
"attributes": {}
}
],
"incomingEdges": []
}