Feat/api versioning#303
Merged
RUKAYAT-CODER merged 6 commits intoApr 23, 2026
Merged
Conversation
|
@Chinonso-Peter Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
# Conflicts: # src/common/interceptors/api-version.interceptor.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implemented.
The API now uses a clear header-based versioning strategy. I wired Nest header versioning into main.ts (line 1), replaced the stubbed common module with real validation middleware in api-versioning.module.ts (line 1), and simplified the shared version helpers/interceptor in api-version.interceptor.ts (line 1). Versioned routes now require X-API-Version, accept 1 or v1, reject missing/invalid/unsupported values early, and echo the resolved version back on the response. I also marked root, health, metrics, webhook, and Swagger paths as version-neutral so infra/docs traffic keeps working.
I documented the strategy in README.md (line 129), added matching Swagger text in src/config/swagger.config.ts (line 1), and added env validation for versioning config in src/config/env.validation.ts (line 1). There’s also a small helper spec in api-version.interceptor.spec.ts (line 1).
Verification: I could not complete a clean npm run typecheck in this workspace because the compiler environment is missing the jest and node type definitions, so tsc stops before checking project code. I also didn’t run lint for the same local tooling reason.
closes #288