Flag overnight blocks in the v2 schedule API
This commit is contained in:
+21
-2
@@ -245,7 +245,9 @@ paths:
|
||||
pairing.
|
||||
|
||||
Returns every Block with its start/end times and the ordered list of
|
||||
selected Proclamation IDs. Proclamation content is not included; the
|
||||
selected Proclamation IDs. Overnight blocks (an end clock time before
|
||||
the start) are supported and flagged with `overnight: true` and a
|
||||
wrapping `durationMinutes`. Proclamation content is not included; the
|
||||
kiosk fetches it separately via `/api/v2/proclamations`.
|
||||
operationId: getSchedule
|
||||
parameters:
|
||||
@@ -498,7 +500,17 @@ components:
|
||||
format: email
|
||||
ScheduleBlock:
|
||||
type: object
|
||||
required: [id, startTime, startMinutes, endTime, endMinutes, proclamationIds]
|
||||
required:
|
||||
[
|
||||
id,
|
||||
startTime,
|
||||
startMinutes,
|
||||
endTime,
|
||||
endMinutes,
|
||||
overnight,
|
||||
durationMinutes,
|
||||
proclamationIds
|
||||
]
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -521,6 +533,13 @@ components:
|
||||
minimum: 0
|
||||
maximum: 1440
|
||||
description: Minutes from midnight.
|
||||
overnight:
|
||||
type: boolean
|
||||
description: True when the end clock time is at or before the start, i.e. the block crosses midnight.
|
||||
durationMinutes:
|
||||
type: integer
|
||||
minimum: 1
|
||||
description: Block length in minutes. An overnight block counts the wrap past midnight as the next day.
|
||||
proclamationIds:
|
||||
type: array
|
||||
description: IDs of the selected Proclamations, in play order.
|
||||
|
||||
Reference in New Issue
Block a user