Repository navigation
API docs: operational and utility endpoints #623
Description
Branch: Open your PR against dev. PRs targeting main are closed automatically.
Description:
Write apps/backend/docs/api-operational-endpoints.md for the routes that sit outside the feature routers in app.ts: GET /health, GET /metrics, GET /me, GET /security/transport-policy, and the development-only /local-storage/* file server.
Acceptance criteria:
- Each endpoint's response shape, auth requirement, and whether it is exempt from the global IP rate limiter (check its position relative to
app.use(rateLimit('global_ip', …))) - Documents
/healthsemantics for orchestrators: which dependencies it checks and what a degraded response looks like - Documents how
/metricsshould be protected in production, and links todocs/observability.mdrather than duplicating the metrics list - Documents the exact condition under which
/local-storageis mounted and confirms it can never be enabled in production
Activity
Luna-netty commentedon Oct 19, 2026
@Luna-netty 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 @Luna-netty to this issue.
0xDeon commentedon Oct 20, 2026
@0xDeon 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 @0xDeon to this issue.
drips-wave commentedon Oct 20, 2026
Congratulations, @0xDeon! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.
🧑💻 @0xDeon: 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 🌊
github-actions commentedon Oct 20, 2026
Closed by #647, merged into
dev.drips-wave commentedon Oct 20, 2026
This issue has been completed by @0xDeon as part of the Stellar Wave Program's 10th Wave 🥳
😎 @0xDeon: 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.