docs(api): say what the batch ingest does with a sample's unit

The field carried no description while the server ignored it. It no
longer ignores it, so the contract has to say so.

Refs #944
This commit is contained in:
Marc-André Bombeck committed 2026-09-09 22:45:17 +02:00
1 parent bc7eff8322
commit bdfff04975
2 files changed
+10 -1

No files matched your search

+3
View File
@@ -21350,6 +21350,9 @@ components:
type: string
minLength: 1
maxLength: 60
description: Apple's `HKUnit` string for `value`. The server converts the reading into the unit it stores the identifier
in when the two differ and the factor is known (`km` to `m`, `lb` to `kg`, `degF` to `degC`, and their
siblings); a unit the server cannot place leaves the reading untouched.
startDate:
type: string
format: date-time
+7 -1
View File
@@ -53,7 +53,13 @@ const batchEntrySchema = z
.describe(
"v1.19.2 (iOS #34 extension) — the bucket's MAXIMUM bpm for a 10-minute heart-rate bucket (see `externalId`). Persisted ONLY on a well-formed `stats:HKQuantityTypeIdentifierHeartRate:<bucket-start>` row; ignored (stored null) on every other entry. Omit on a pre-v1.19.2 client — the bucket keeps the avg-only contract.",
),
unit: z.string().min(1).max(60),
unit: z
.string()
.min(1)
.max(60)
.describe(
"Apple's `HKUnit` string for `value`. The server converts the reading into the unit it stores the identifier in when the two differ and the factor is known (`km` to `m`, `lb` to `kg`, `degF` to `degC`, and their siblings); a unit the server cannot place leaves the reading untouched.",
),
startDate: z.iso.datetime({ offset: true }),
endDate: z.iso.datetime({ offset: true }),
sleepStage: z