Skip to content

Document the consumed StableRoute API endpoints in the in-app docs page #26

Description

@mikewheeleer

Document all consumed API endpoints on the in-app docs page

Description

src/app/docs/page.tsx lists only five endpoints, but the UI actually calls more — GET /api/v1/stats, GET/POST/DELETE /api/v1/api-keys, GET /api/v1/events, and GET/POST/DELETE /api/v1/webhooks (see the corresponding pages). This issue brings the in-app docs in sync with what the dashboard consumes.

Requirements and context

  • Repository scope: StableRoute-Org/Stableroute-frontend only.
  • Extend the sections array in docs/page.tsx to cover stats, api-keys (create/list/revoke), events, webhooks, and admin status, each with method + path + one-line description matching real usage in src/app.
  • Keep the existing accessible <dl> structure and the link to GET /api/v1/openapi.json.
  • Cross-reference each endpoint with the page that uses it.
  • Do not invent endpoints — only document those actually called by the frontend.

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b docs/api-docs-26-endpoint-sync
  • Implement changes
    • Write code in: src/app/docs/page.tsx.
    • Write comprehensive tests in: create src/app/docs/page.test.tsx asserting key endpoints render.
    • Add documentation: ensure consistency with README.md endpoint list.
    • Add comments mapping each entry to its consuming page.
    • Validate every documented path matches an actual call site.
  • Test and commit

Test and commit

  • Run npm run lint, npm test, and npm run build.
  • Cover edge cases: all endpoints present, correct methods, and the openapi link intact.
  • Include the full npm test output in the PR description.

Example commit message

docs: sync in-app API docs page with consumed endpoints

Guidelines

  • Minimum 95 percent test coverage for impacted modules.
  • Clear, reviewer-focused documentation.
  • Timeframe: 96 hours.

Community & contribution rewards

  • 💬 Join the StableRoute community on Discord for questions, reviews, and faster merges: https://discord.gg/37aCpusvx
  • ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — if this issue and the maintainers helped you ship, we'd be grateful for a 5-star rating. Clear questions in Discord and tidy, well-tested PRs are the fastest path to a merge and a reward.

Metadata

Metadata

Assignees

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions