[BACK-2520] Adding sleep schedules to pump settings #78
Conversation
| 16. [Units (`units`)](#units-units) | ||
| 17. [Examples](#examples) | ||
| 18. [Keep Reading](#keep-reading) | ||
| 1. [Type (`type`)](#type-type) |
There was a problem hiding this comment.
I use VS Code with Markdown All In One which auto-generates TOCs :)
There was a problem hiding this comment.
It annoyed me that this ordered list would have to be updated every time you wanted to add a new item anywhere, so I changed it to all 1.s.
And then I just learned that Markdown doesn't care at all what numbers you use, as long as the first one is 1: https://www.markdownguide.org/basic-syntax/#ordered-lists
| sleepSchedules: | ||
| type: array | ||
| minItems: 0 | ||
| maxItems: 10 |
There was a problem hiding this comment.
Is this imposed from some external spec, or just a reasonable upper limit?
There was a problem hiding this comment.
It's just a reasonable upper limit.
| maximum: 86400 | ||
| description: end time in seconds, offset from midnight (e.g. 7am is 25200) | ||
| required: | ||
| - enabled |
There was a problem hiding this comment.
Nit: extra indent, though I don't think YAML / OAS3 cares.
There was a problem hiding this comment.
Is it fair to assume that if enabled: true then other fields are required?
Unfortunately I think the only way to express conditional requirement in OAS3 is rather ugly: defining two separate yet somewhat redundant types, one which requires all fields (with enabled: true), and the other with just enabled: false. And then stitch them together with a oneOf at the top level.
There was a problem hiding this comment.
Yeah, I tried that and it was so ugly that I took it out again 😂 The cleanest way I found was to use conditional operators (if/then/else) but that was only added in OAS 3.1, which doesn't seem to be fully supported by Stoplight. Redoc on the other hand: Redocly/redoc#1939
Interesting. You might have an old npm version? That said, apparently the |
| format: integer | ||
| minimum: 0 | ||
| maximum: 86400 | ||
| description: end time in seconds, offset from midnight (e.g. 7am is 25200) |
There was a problem hiding this comment.
Is it possible for end <= start? AFAIK there's no cross-field validation in OAS3 so it's mainly idle curiosity.
Or perhaps more importantly, how does one express something like "start at 11pm on Tuesday, end at 7am Wednesday"? Something like { enabled: true, days: [ "Tuesday", "Wednesday" ], start: 8200, end: 25200 }? But that might be ambiguous?
There was a problem hiding this comment.
Yes, end can be smaller than start. In fact, that is the most likely case. To express your example, you would just do:
{ "enabled": true, "days": [ "Tuesday" ], "start": 82800, "end": 25200 }
|
@tjotala Anything else that you need me to do on this PR? |
Adds the data model changes for BACK-2520. This is my first time making any changes to TidepoolApi, and my first time using OpenAPI, so please double-check that I've crossed all the t's and dotted all the i's.
I've also changed the location parameter for
npm installto-g, as--location=globalwasn't working for some reason.