Skip to content

Added OpenAPI docs and more comments #35

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
KopitarFan merged 1 commit into from
Jun 29, 2026
Merged

Added OpenAPI docs and more comments #35

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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The core paradigm is inverted from client-server:
- Tests: `test/`
- Product milestones: `docs/milestones.md`
- Architecture notes: `docs/local-first-architecture.md`
- Server REST API contract: `docs/server-rest-api.md`
- Server runbook: `docs/server-production-runbook.md`
- Observability options: `docs/observability-options.md`
- iOS release packaging: `docs/release-packaging.md`
Expand Down
4 changes: 4 additions & 0 deletions docs/server-production-runbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ Last updated: 2026-06-26

This runbook covers the All Of Me cloud-save API running on Vultr.

For request and response details, see the REST API contract in
`docs/server-rest-api.md`.

## Production Topology

- Public API: `https://api.allofmeapp.com`
- Health check: `https://api.allofmeapp.com/healthz`
- Swagger UI: `https://api.allofmeapp.com/docs`
- Container image: `ghcr.io/kopitarfan/all-of-me-server:latest`
- Host: Vultr Ubuntu instance
- Reverse proxy: Caddy
Expand Down
Loading
Loading