mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 12:32:43 +00:00
Marc-André Bombeck
f38c4bed05
Define the go-forward aggregated heart-rate upload shape so clients can stop posting one Measurement per raw HealthKit sample. A heart-rate row keyed `stats:HKQuantityTypeIdentifierHeartRate:<bucket-start-hour>` carries the hour's average bpm as a single PULSE row and rides the existing `stats:` overwrite path: a re-post within the hour overwrites the value instead of duplicating, identical to the per-day cumulative rows. The hour boundary is UTC so the key is timezone-stable. The batch route rejects a row that targets the heart-rate bucket prefix with a malformed hour suffix as a per-entry skip (`malformed_hr_bucket_id`) rather than persisting an un-overwriteable row; well-formed buckets, per-sample uuid ingest, and the per-day cumulative overwrite path are all unchanged. Average-only for now — the measurement row carries a single value column, so hourly min/max would need a schema change and is left as a follow-up. Documents all three externalId shapes plus the `updated` status in the OpenAPI contract.
docs/ — internal reference + operator playbooks
The user-facing documentation lives at https://docs.healthlog.dev — that's the canonical surface for self-hosting guides, integration walkthroughs, AI-provider setup, and the doctor-report workflow.
The files in this directory are the internal operator playbooks, audit notes, and machine-readable specs that ship alongside the source:
api/— the OpenAPI 3.1 spec for the native-client subset (iOS DTO codegen target). Seeapi/README.mdfor the preview commands.ops/— backup / restore + encryption-key-rotation playbooks. These are the runbooks an operator reaches for during an incident.self-hosting/— horizontal-scaling notes (HEALTHLOG_PROCESS_TYPE=web|worker|all) and the deploy-pipeline recipe. Routine install steps stay ondocs.healthlog.dev.migration/— release-by-release migration notes. Read the entry for the version you're upgrading from.audit/— per-release audit summaries archived for forensic traceability.apple-store-connect-checklist.md— the iOS submission gate.doctor-report.md— PDF generator design notes.codex-protocol-spec.md— Codex / ChatGPT OAuth protocol reverse-engineering notes.ui-guidelines.md— UI / a11y house style.
If you're a self-hoster looking to spin up an instance, start at https://docs.healthlog.dev or jump to the Quick Start in the project README.