Repository navigation
Backend error-code and error-response catalog #555
Description
Write apps/backend/docs/contracts-error-catalog.md: every error shape the backend returns, across both transports. REST handlers return { error, ... } with varying extra fields; socket handlers emit an error event whose payload carries an event name and sometimes a code. There is currently no single place to look up what a client can receive.
Acceptance criteria:
- One table of REST errors: status,
errorstring, extra fields, and the route(s) that emit it - One table of socket errors keyed by the emitted
eventvalue, including the non-obvious ones —device_set_mismatch,protocol_mismatch,rate_limited,envelope_too_large - Documents which errors are retryable and which are terminal
- Notes the rate-limit response shape (
429plusRetry-AfterandRateLimit-*headers)
Activity
cynthia1-rgb commentedon Aug 27, 2026
@cynthia1-rgb has applied to work on this issue as part of the Stellar Wave Program's 8th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @cynthia1-rgb to this issue.
Deb-Auth commentedon Aug 30, 2026
@Deb-Auth has applied to work on this issue as part of the Stellar Wave Program's 8th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @Deb-Auth to this issue.
drips-wave commentedon Aug 30, 2026
Congratulations, @Deb-Auth! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.
🧑💻 @Deb-Auth: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.
Warning
When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.
🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.
🌊 Happy Wave 🌊
docs(backend): add error code and error response catalog
github-actions commentedon Aug 31, 2026
Closed by #597, merged into
dev.drips-wave commentedon Aug 31, 2026
This issue has been completed by @Deb-Auth as part of the Stellar Wave Program's 8th Wave 🥳
😎 @Deb-Auth: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.
🧑💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.