Skip to main content
This page is for contributors working on the backend service and its infrastructure, not for customer integrations.

Prerequisites

  • Python 3.13+
  • uv
  • AWS CLI with the correct profile configured
  • Docker for Lambda packaging
  • Node.js and AWS CDK for infrastructure commands

Set up the project

uv sync
If you are bootstrapping a fresh environment, install the CDK CLI as well:
npm install -g aws-cdk

Run tests during development

Use the smallest relevant pytest target while you work, then run the full suite before merge:
uv run pytest tests/path/to/target_test.py
Longer runs are easier to follow with progress-style output:
uv run pytest -vv -o console_output_style=progress

Useful CDK commands

cdk bootstrap --profile onvy-api --context environment=staging
cdk diff --profile onvy-api --context environment=staging
cdk synth --profile onvy-api --context environment=staging
cdk deploy --all --profile onvy-api --context environment=staging --require-approval never

Notes for this docs site

If you are editing the Mintlify portal in health-api-docs, preview it from that directory:
mint dev
Mintlify currently expects a supported Node LTS runtime. In this environment, use Node 20.17.0+ and avoid Node 25.x for mint dev. Use mint validate or mint broken-links before publishing content changes.