API changelog maintained
Why it matters
Without an API-specific changelog, consumers upgrading between versions have no way to know which endpoints changed, which fields were added, or which response shapes shifted. A general project changelog that says "various API improvements" is not a substitute. iso-25010:2011 maintainability.modifiability is directly impacted: the cost of each API change is borne by consumers who must diff the implementation themselves rather than reading a curated list of what changed and what they need to update.
Severity rationale
Low because a missing changelog does not cause immediate failure but significantly increases the cost of every consumer upgrade and creates friction for third-party SDK maintainers.
Remediation
Start an API changelog focused exclusively on changes to the API contract. Keep it in API_CHANGELOG.md or a /changelog endpoint, separate from the general project changelog:
# API Changelog
## v1.2.0 - 2026-03-15
### Added
- GET /api/v1/users/:id/preferences
- `timezone` field on User response
### Changed
- GET /api/v1/orders now returns `items` array (was `orderItems`)
### Deprecated
- POST /api/v1/users/search -- use GET /api/v1/users?q= instead
Every entry should include the endpoint affected, what changed, and any migration action required. Date and version-tag every release.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the API Design Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · maintainability.modifiability — Modifiability — changelog enables consumers to track API evolution
Taxons
History
- 2026-04-18·v1.0.0·Initial import from api-design·automated