II.
Workflow overview
Reference · liveworkflow:api-design-review
API Design Review overview
Structured cross-team review triggered whenever a team proposes a new public or internal API contract. The proposing team documents endpoints, data schemas, error codes, and versioning strategy in an API design document or OpenAPI spec. A review panel of architects, backend engineers, and consumer-team leads evaluates the design for consistency, backward compatibility, security, and developer experience. Feedback is incorporated and a second round of review may follow. Final approval gates implementation work. The workflow ensures APIs are coherent, stable, and easy to consume across organizational boundaries.
Attributes
displayName
API Design Review
description
Structured cross-team review triggered whenever a team proposes a new public or
internal API contract. The proposing team documents endpoints, data schemas, error
codes, and versioning strategy in an API design document or OpenAPI spec. A review
panel of architects, backend engineers, and consumer-team leads evaluates the design
for consistency, backward compatibility, security, and developer experience. Feedback
is incorporated and a second round of review may follow. Final approval gates
implementation work. The workflow ensures APIs are coherent, stable, and easy to
consume across organizational boundaries.
workflowKind
development
triggerType
on-demand
typicalCadence
per-api-change
complexity
moderate
Outgoing edges
applies_to_domain4
- domain:software-engineering·DomainSoftware Engineering
- domain:web-development·DomainWeb Development
- domain:software-engineering·DomainSoftware Engineering
- domain:web-development·DomainWeb Development
involves_role8
- role:architect·RoleArchitect
- role:backend-engineer·RoleBackend Engineer
- role:tech-lead·RoleTech Lead
- role:solutions-architect·RoleSolutions Architect
- role:technical-writer·RoleTechnical Writer
- role:staff-engineer·RoleStaff Engineer
- role:code-reviewer·RoleCode Reviewer
- role:tech-lead·RoleTech Lead
performed_by_org_unit2
- org-unit:engineering·OrgUnitEngineering
- org-unit:architecture-guild·OrgUnitArchitecture Guild
requires_skill_area2
- skill-area:graphql-schema-design·SkillAreaGraphQL Schema Design
- skill-area:rate-limiting·SkillAreaRate Limiting
triggers_responsibility5
- responsibility:architecture-decision·ResponsibilityArchitecture Decision
- responsibility:documentation·ResponsibilityDocumentation
- responsibility:stakeholder-communication·ResponsibilityStakeholder Communication
- responsibility:review-architecture-changes·ResponsibilityReview architecture changes
- responsibility:adr-curation·ResponsibilityADR curation
Incoming edges
follows_workflow3
- stack-profile:api-gateway-microservices·StackProfileAPI Gateway & Microservices (Kong/Envoy + gRPC + Kubernetes + Go)
- stack-profile:graphql-api-platform·StackProfileGraphQL API Platform (Apollo Server + Prisma + PostgreSQL + React + TypeScript)
- stack-profile:backend-for-frontend·StackProfileBackend for Frontend — BFF (TypeScript, Express, GraphQL, React, Docker)
lib_implements_workflow14
- lib-agent:software-architecture--api-design-architect·LibraryAgentapi-design-architect
- lib-agent:web-development--api-architect·LibraryAgentapi-architect
- lib-agent:web-development--api-documentation·LibraryAgentapi-documentation
- lib-agent:web-development--graphql-developer·LibraryAgentgraphql-developer
- lib-process:software-architecture--api-design-specification·LibraryProcessspecializations/software-architecture/api-design-specification
- lib-process:web-development--graphql-api-apollo·LibraryProcessspecializations/web-development/graphql-api-apollo
- lib-process:web-development--restful-api-nodejs·LibraryProcessspecializations/web-development/restful-api-nodejs
- lib-process:web-development--trpc-api-development·LibraryProcessspecializations/web-development/trpc-api-development
- lib-skill:software-architecture--graphql-schema-generator·LibrarySkillgraphql-schema-generator
- lib-skill:software-architecture--openapi-generator·LibrarySkillopenapi-generator
- lib-skill:software-architecture--openapi-validator·LibrarySkillopenapi-validator
- lib-skill:software-architecture--swagger-ui-deployer·LibrarySkillswagger-ui-deployer
- lib-skill:web-development--openapi·LibrarySkillopenapi
- lib-skill:web-development--rest-api-design·LibrarySkillrest-api-design