mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 12:32:43 +00:00
Four verified HIGH data-integrity fixes, each in-place per-provider (no shared helper), from the campaign's data-integrity audit + adversarial verification: F1 — drain-per-sample-cumulative buildScanWhere was the only one of four sibling drains missing deletedAt: null; the nightly cumulative fold re-summed soft-deleted Apple samples and hard-deleted the legacy-steps audit tombstones. Added the filter (mirrors consolidate-daily-mean, dense-intraday-retention, consolidate-legacy-steps). F2 — the additive late-fold merge had no single-flight guard, so two overlapping runs (deploy overlap, or the admin endpoint racing the cron) produced a permanent 2x daily total. Added a pg_advisory_xact_lock per (user, externalId) plus an in-transaction re-read of the live contributors so the serialised-second fold contributes zero (a bare lock alone would still re-add its stale scanned sum). Mirrors the documents quota advisory-lock pattern. F3 — Withings sleep externalId keyed on segment START while measuredAt + the natural key use END; a re-scored segment missed the externalId probe, the sweep tombstoned the old row, and the re-keyed insert collided on the natural key and wedged. Added the natural-key rescue (re-key in place), mirroring the same-file measure path. F4 — Withings measure sync stamped lastSyncedAt + recordSyncSuccess unconditionally after a warn-only per-row loop; a transient write failure stranded the reading behind the 10-min overlap forever. Now holds the watermark and records failure on a hard row error (mirrors google-health/fitbit), while a benign P2002 still advances. Regression test per finding (reverting the three source files fails exactly four tests). Integration suite green against real Postgres.
HealthLog API Spec
openapi.yaml is the canonical OpenAPI 3.1 description for the HealthLog
Next.js API. It is the source of truth for the native iOS client's
DTO codegen.
The MCP server is documented separately — it is a distinct contract over JSON-RPC, not part of the REST OpenAPI spec:
mcp-capabilities.md— the tool, resource, and prompt catalogue, the grounding contract, and the write model.mcp-skills.md— building a connector or skill on top of it.../self-hosting/mcp.md— enabling and connecting the surface (operator guide).
Preview locally
Open an interactive Redoc preview in your browser:
npx @redocly/cli preview docs/api/openapi.yaml
Generate static HTML for sharing:
npx @redocly/cli build-docs docs/api/openapi.yaml --output docs/api/index.html
Validate
npx @redocly/cli lint docs/api/openapi.yaml
The spec is expected to be lint-clean (errors = 0). Some warnings are intentional:
no-server-example.com—http://localhost:3000is the dev server.operation-2xx-response/operation-4xx-response— webhook + redirect endpoints intentionally omit one or the other.no-unused-components—ReminderPhaseis exposed for client codegen even though no path response references it directly.
Layout
info— title, version (mirrored frompackage.json), description.servers— productionhttps://healthlog.bombeck.ioplushttp://localhost:3000for local development.tags— domain groupings (Auth,Measurements,Medications,Mood,Dashboard,Insights,Achievements,DoctorReport,Integrations,User,Tokens,Notifications,Onboarding,Health,Settings,Analytics,Export,AuditLog,Monitoring,Webhooks,Ingest,Admin).securitySchemes:bearerAuth— long-livedhlk_*API tokens issued viaPOST /api/tokens. Required on/api/ingest/medication.sessionCookie— HttpOnlyhealthlog_sessioncookie set by the password and passkey login flows. Used by the web app and any iOS client running inside a web view.
components.schemas— DTOs for all routes plus the underlying Prisma models (e.g.Measurement,Medication,MedicationIntakeEvent,MoodEntry,User,DashboardLayout,ApiEnvelope,ApiError).paths— all routes fromsrc/app/api/**/route.ts, including the/api/admin/*family which is taggedAdminand marked internal.
Conventions
- Successful responses use the envelope
{ data, error: null }. - Error responses use the envelope
{ data: null, error: '<message>' }. - Pagination uses
limit+offsetquery parameters and ameta: { total, limit, offset }block on the response. - All timestamps are ISO 8601 / RFC 3339 (
format: date-time) in UTC. - IDs are CUIDs (opaque strings).
Updating the spec
When adding or changing routes:
- Update the relevant route handler under
src/app/api/**/route.ts. - Mirror the change in
openapi.yaml. KeepoperationIdcamelCase and stable — the iOS codegen keys off it. - Run
npx @redocly/cli lint docs/api/openapi.yamland resolve all errors. Warnings are tolerated when documented above. - Bump
info.versionif the change is breaking for clients.