Skip to content

docs(api): synchronize API.md with actual routes in routes/mod.rs (#7) - #75

Open
ghzhost wants to merge 1 commit into
StellarSend:mainfrom
ghzhost:fix/docs-api-routes-sync-7
Open

docs(api): synchronize API.md with actual routes in routes/mod.rs (#7)#75
ghzhost wants to merge 1 commit into
StellarSend:mainfrom
ghzhost:fix/docs-api-routes-sync-7

Conversation

@ghzhost

@ghzhost ghzhost commented Sep 3, 2026

Copy link
Copy Markdown

Summary

Closes #7.

Synchronizes with the live router registered in :

  • Updated Base URL notation to standard service base URL ( / ).
  • Documented authentication requirements across all protected and public endpoints.
  • Added standard success and error response envelope structure.
  • Documented all registered routes:
    • Health ()
    • Authentication (, )
    • Payments (, , , )
    • Transactions (, )
    • Accounts (, )
    • Rates ()
    • Subscriptions (, , , )
    • Payment Requests (, , , , )
    • Escrows (, , , , , , )
    • Keeper ()
  • Removed obsolete and unregistered stub endpoints (, etc.) that are not present in the live router.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/API.md is out of sync with actual routes in src/routes/mod.rs

1 participant