feat(backend): add operational runbook links for common error codes#1151
Open
MztaKing wants to merge 1 commit into
Open
feat(backend): add operational runbook links for common error codes#1151MztaKing wants to merge 1 commit into
MztaKing wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Closes #1129
This change adds operational runbook support for common backend error codes by mapping each known errorCode to a docsUrl and including that URL in standardized error responses. It also adds runbook documentation for the top common failure cases, improving developer guidance when errors occur.
What’s included
Error code → runbook/docs URL mapping
docsUrl added to standardized error payloads
Runbook pages added for common failures such as auth, validation, DB, RPC, and rate limiting
Regression test covering docsUrl emission in error responses
Verification
Ran:
cd backend && pnpm exec jest src/common/filters/enhanced-exception.filter.spec.ts --runInBand
Result: 1/1 test suite passed, 1/1 test passed