Skip to content

docs(api): add OpenAPI 3.1 spec for the full API surface #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zeemscript merged 1 commit into from
Jul 29, 2026
Merged

docs(api): add OpenAPI 3.1 spec for the full API surface #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ dashboard is available at `/admin/jobs`.
| Stellar Wallet | `/api/stellar/wallet/*` |
| Stellar Payments | `/api/stellar/payment/*` |

### Machine-readable spec

The full OpenAPI 3.1 contract for every mounted route lives in [`openapi.yaml`](openapi.yaml).
Open it in any OpenAPI viewer (Swagger Editor, Redoc, Stoplight) or point a client generator
at it. It documents auth requirements, path and query parameters, request bodies, response
schemas and status codes, reusable schemas for the core models, the standard error shape, and
the endpoints whose response envelope is still non-standard.

## 🌊 Contributing & Drips Wave

This repository participates in the **[Stellar Drips Wave](https://www.drips.network/wave/stellar)** bounty program — contributors earn Points (and real rewards) for resolving this repo's issues during a Wave, with complexity tiers set in the Drips Wave app.
Expand Down
Loading
Loading