Create API docs for freighter-backend-v2

[CassioMG]

We currently have lots of endpoints for freighter-backend but with no documentation which result in devs spending a lot of time trying to figure out what each endpoint does and return as response or else stealing time from Piyral and Aristides to do so.

We could try using Cursor to create a first version of the API docs for each endpoint then review and polish it so devs can easily check what each endpoint is capable of thus increasing the team performance.

See below for all available endpoints as of today:

• "/ping"
• "/price-worker-health"
• "/rpc-health"
• "/horizon-health"
• "/feature-flags"
• "/user-notification"
• "/account-history/:pubKey"
• "/account-balances/:pubKey"
• "/token-details/:contractId"
• "/token-spec/:contractId"
• "/contract-spec/:contractId"
• "/is-sac-contract/:contractId"
• "/scan-dapp"
• "/scan-tx"
• "/scan-asset"
• "/scan-asset-bulk"
• "/report-asset-warning"
• "/report-transaction-warning"
• "/token-prices"
• "/subscription/token"
• "/subscription/account"
• "/subscription/token-balance"
• "/submit-tx"
• "/simulate-tx"
• "/simulate-token-transfer"
• "/onramp/token"

[aristidesstaffieri]

we can generate docs from the API itself using this https://github.com/fastify/fastify-swagger

[JakeUrban]

https://docs.devin.ai/get-started/devin-intro

[Keeeeeeeks]

7/14 update:

• Deepwiki will re-index servers every week, if we add the badge.
• Could revisit in v2

[Keeeeeeeks]

10/6

• We haven't moved all of the endpoints to freighter-backend-v2
• Moving all endpoints to FBv2 is a requirement for updating API docs accurately

[Keeeeeeeks]

11/17

• We haven't yet moved all of the endpoints to freighter-backend-v2
• Moving all endpoints to FBv2 is a requirement for updating API docs accurately

[Keeeeeeeks]

Can start with DeepWiki; will likely get rolled into a docpocalypse