👋 New to open source?
Thanks for considering contributing to Mutiny.
This issue is intentionally beginner-friendly.
If you get stuck, ask questions in the comments.
We're happy to help.
Context
Cold start and README mention health checks, but field meanings for GET /api/health are not written down. The response model is HealthResponse in apps/api/src/mutiny_api/schemas.py (status, api, db, model, version, plus ops fields like mutator_mode, llm_configured, db_latency_ms, …).
Goal
Document the observed /api/health fields so operators and contributors know what “healthy” means.
Why it matters
Newcomers running ./scripts/dev.sh see a JSON blob first; a short field guide turns that into confidence instead of guesswork.
Acceptance criteria
Suggested files
- New or existing doc under
docs/ (e.g. section in COLD_START or docs/API_HEALTH.md)
- Optional:
tests/integration/ assert on key names
- Reference:
apps/api/src/mutiny_api/schemas.py, apps/api/src/mutiny_api/app.py
Out of scope
- Changing health payload shape, auth, or Hosted UI health widgets
Hints
- Prefer documenting observed JSON + a one-line meaning per field over copying the entire Pydantic model docstring.
- Call out which fields are core vs ops extras (
mutator_mode, running_campaigns, …).
- If you add a test, assert key names, not brittle values like latency.
Difficulty
S · backend docs
Docs
👋 New to open source?
Thanks for considering contributing to Mutiny.
This issue is intentionally beginner-friendly.
If you get stuck, ask questions in the comments.
We're happy to help.
Context
Cold start and README mention health checks, but field meanings for
GET /api/healthare not written down. The response model isHealthResponseinapps/api/src/mutiny_api/schemas.py(status,api,db,model,version, plus ops fields likemutator_mode,llm_configured,db_latency_ms, …).Goal
Document the observed
/api/healthfields so operators and contributors know what “healthy” means.Why it matters
Newcomers running
./scripts/dev.shsee a JSON blob first; a short field guide turns that into confidence instead of guesswork.Acceptance criteria
GET /api/health(start Hosted via./scripts/dev.shor uvicorn, thencurl -s http://127.0.0.1:8000/api/health)docs/README.mdand/ordocs/COLD_START.mdSuggested files
docs/(e.g. section in COLD_START ordocs/API_HEALTH.md)tests/integration/assert on key namesapps/api/src/mutiny_api/schemas.py,apps/api/src/mutiny_api/app.pyOut of scope
Hints
mutator_mode,running_campaigns, …).Difficulty
S · backend docs
Docs