Search docs
Docs searchValidation rule
Back to Rule CatalogAP-API-013API DesignInconsistent resource design within API
Flags REST resources that use inconsistent naming, shape, or operation patterns.
warningviolationNo auto-fix
How to fix
- Align route naming and response shape with adjacent resources.
- Document intentional exceptions in the API style ADR.
- Update clients and contracts together.
What it means
Related API endpoints appear to model resources inconsistently.
Why it matters
Consistent resource design improves client ergonomics and contract review.
Common causes
- Endpoints were added by different teams without a shared convention.
- A resource was renamed in code but not in the contract.
- Action-style routes mix with resource-style routes unnecessarily.
Example bad pattern
The API mixes /teams/:id/system, /systemTeams, and /assign-system for the same relationship.Example good pattern
Relationship operations use one documented resource naming pattern.Related files/config
contracts/openapi.yamlapps/api/src
Related CLI commands
archpilot validatearchpilot validate --ci
Related docs