docs(api): describe how a record-only schedule is kept on update

This commit is contained in:
Marc-André Bombeck committed 2026-09-25 09:25:40 +02:00
1 parent f482fc403c
commit d4c6e0fab2
1 file changed
+8 -2
+8 -2
View File
@@ -23141,7 +23141,10 @@ components:
information, but nothing is ever due: no reminder on any channel, no projected slot, no entry on the today
list or the doses card, and no adherence figure anywhere. Existing intake history stays stored. Switching it
back on resumes from that moment; the time it was off never counts as missed. Omitted on update leaves the
current value."
current value. On a medication whose tracking is off, an update that does not name `trackIntake` leaves its
stored schedule alone: `schedules`, `asNeeded` and `oneShot` in such a request are ignored (a client that
does not know the field cannot have seen the stored schedule, which is served in `recordedSchedules`). Name
`trackIntake` to change the schedule of such a medication."
type: boolean
schedules:
type: array
@@ -23463,7 +23466,10 @@ components:
information, but nothing is ever due: no reminder on any channel, no projected slot, no entry on the today
list or the doses card, and no adherence figure anywhere. Existing intake history stays stored. Switching it
back on resumes from that moment; the time it was off never counts as missed. Omitted on update leaves the
current value."
current value. On a medication whose tracking is off, an update that does not name `trackIntake` leaves its
stored schedule alone: `schedules`, `asNeeded` and `oneShot` in such a request are ignored (a client that
does not know the field cannot have seen the stored schedule, which is served in `recordedSchedules`). Name
`trackIntake` to change the schedule of such a medication."
type: boolean
schedules:
type: array