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 the rule validates
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.
Typical violation example
The API mixes /teams/:id/system, /systemTeams, and /assign-system for the same relationship.Typical compliant example
Relationship operations use one documented resource naming pattern.Related rules
AP-API-010 - Missing pagination on collection endpointAP-API-011 - Bulk operation riskAP-API-012 - DTO/entity leakage through API boundaryAP-API-014 - API versioning strategy inconsistency
Adjacent categories
Related files/config
contracts/openapi.yamlapps/api/src
Related CLI commands
archpilot validatearchpilot validate --ci
Related docs