Query parameter naming is consistent
Why it matters
When one list endpoint paginates with page/limit and another with offset/count, every consumer building a generic list component must branch on the endpoint. Sorting inconsistency — sort on one, orderBy on another — means documentation is never sufficient; developers must check each endpoint individually. This is a direct iso-25010:2011 maintainability.modifiability failure: the API surface area effectively doubles for consumers who need to handle multiple list endpoints.
Severity rationale
Medium because inconsistent query parameter naming imposes per-endpoint special-casing on every client without enabling security vulnerabilities.
Remediation
Define a standard set of query parameter names once and apply them everywhere. Create a shared query parameter parser that all list endpoints import:
// Standard pagination (pick one set, never both):
?page=1&limit=20
// Standard sorting:
?sort=created_at&order=desc
// Standard filtering:
?status=ACTIVE&type=PREMIUM
// Standard search:
?q=search+term
Document these names in your API reference and enforce them with a shared middleware or parser module so new endpoints cannot diverge.
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
Taxons
History
- 2026-04-18·v1.0.0·Initial import from api-design·automated