chore(backend): formalize API v1 versioning and deprecation headers (#39)#58
Merged
greatest0fallt1me merged 2 commits intoStreampay-Org:mainfrom Mar 25, 2026
Merged
Conversation
… and document the API versioning policy.
|
@Adedayo-Data 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! 🚀 |
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
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.
Description
Refactored the API architecture to use a versioned mounting strategy under
/api/v1. This PR also introduces standard headers to support future deprecation and sunset policies without breaking changes.Key Changes
src/api/v1/router.tsto centralize all v1 logic./api/v1/streams.X-API-Version: v1Deprecation: false(Prepared for future lifecycle management)./healthand/webhooksat the root level for infrastructure/webhook compatibility.Verification
curl -I: Confirmed versioning headers are present in responses.npm test: Verified all stream tests now point to the versioned paths.