api-change

API Change Detection & Guardian Rules

Critical API Paths

Changes to ANY of these paths require @api-guardian:

src/api/**
backend/routes/**
shared/types/**
**/interfaces/**
*.d.ts
openapi.yaml
schema.graphql
swagger.json
**/dto/**
**/contracts/**

Automatic Detection

The check-api-impact.js hook runs on every Write|Edit operation and:

1. Checks if the modified file matches critical paths
2. Analyzes the diff for breaking changes
3. Finds downstream consumers
4. Warns if @api-guardian has not been called

@api-guardian Responsibilities

When called, @api-guardian MUST:

1. Analyze the change type:

   • Additive (new fields, new endpoints) — safe
   • Modification (type changes, renames) — potentially breaking
   • Removal (deleted fields, removed endpoints) — BREAKING

2. Identify all consumers:

   • Search for imports/usage of modified types
   • Check API endpoint consumers
   • Verify downstream dependencies

3. Assess impact:

   • How many consumers affected?
   • Is there a migration path?
   • Can it be done non-breaking?

4. Produce report:

   • Change classification (additive/modification/removal)
   • Consumer impact list
   • Migration strategy
   • Recommendation (proceed/modify/abort)

Breaking Change Protocol

If a change is classified as BREAKING:

1. @api-guardian marks it as BREAKING in report
2. @architect must review and approve the break
3. @builder must update ALL affected consumers
4. @scribe must document the breaking change in CHANGELOG
5. Version bump MUST be MAJOR (X.0.0)

Consumer Impact Matrix

Change Type	Consumer Impact	Action Required
New field added	None	Proceed
Optional → Required	HIGH	Update all consumers
Type changed	HIGH	Migration needed
Field removed	CRITICAL	Major version bump
Endpoint removed	CRITICAL	Deprecation period first
New endpoint	None	Document in API docs

Workflow Position

@architect (API design)
    ↓
@api-guardian (THIS — impact analysis)  ← MANDATORY
    ↓
@builder (implementation + consumer updates)

@api-guardian sits between @architect and @builder to catch breaking changes BEFORE implementation begins.