Repository navigation
How-to: add a new REST endpoint end-to-end #617
Description
Branch: Open your PR against dev. PRs targeting main are closed automatically.
Description:
Write apps/backend/docs/howto-add-rest-endpoint.md: the conventions a new route is expected to follow — router file under routes/, mounting in app.ts, requireAuth, a Zod schema passed to validate(), a rate limiter, an audit event where security-relevant, and tests in src/__tests__/.
Acceptance criteria:
- A worked example of a small authenticated endpoint, from schema to test
- Explicitly covers mounting in
app.ts, and usesroutes/auditLogs.tsas the cautionary example:auditLogsRouteris defined but is not mounted inapp.tstoday, soGET /audit-logsis unreachable (file a separate bug if it is still unmounted when this doc is written) - Documents when to call
recordAuditEventand which metadata is safe to record - Documents the expected error-response shape and links to the error catalog (feat(auth): reuse device schema for auth verify and /devices route #325)
- Documents test conventions: mocked Redis/Postgres, never a real service, consistent with the testing guide (
GET /conversations/:id/messages: per-device ciphertext shape +unavailablemarker #336)
Activity
TMTOFFUTA commentedon Oct 19, 2026
@TMTOFFUTA has applied to work on this issue as part of the Stellar Wave Program's 10th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @TMTOFFUTA to this issue.
Depo-dev commentedon Oct 20, 2026
@Depo-dev has applied to work on this issue as part of the Stellar Wave Program's 10th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @Depo-dev to this issue.
drips-wave commentedon Oct 20, 2026
Congratulations, @Depo-dev! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.
🧑💻 @Depo-dev: 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: add token transfer flow, testnet treasury tutorial, rest endpoi…
github-actions commentedon Oct 20, 2026
Closed by #649, merged into
dev.drips-wave commentedon Oct 20, 2026
This issue has been completed by @Depo-dev as part of the Stellar Wave Program's 10th Wave 🥳
😎 @Depo-dev: You earned 200 Points for completing this issue! Once the Wave's rewards are finalized, 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.