Skip to content

[Docs] Write a complete backend API reference (endpoints, auth, payloads, errors) #2

@grantfox-oss

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

There is no API reference anywhere in the docs repo, yet the backend exposes many routes (loans, pool, remittances, score, notifications, admin, indexer, auth). Contributors and integrators have to read the source to learn the API surface, auth model, and error shapes.

Acceptance criteria

  • Document every public endpoint grouped by domain, with method, path, auth requirement, request schema, and response schema
  • Document the auth models (JWT bearer, internal API key) and which endpoints use which
  • Document the standardized error response shape and common error codes
  • Note idempotency and rate-limit behavior where it applies

Files to touch

  • api-reference.md (new)
  • wiki/README.md

Out of scope

  • Auto-generating from OpenAPI (can be a follow-up)
  • Client SDK docs

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationhardAdvanced / high-difficulty issuehelp wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions