Design and implement API endpoints "/program/*"

Parent: [EPIC] Display virtual timeslots / Music Fallba... (aura#176 - closed)

Currently we have these endpoints for presenting data on the website:

• /program/{year}/{month}/{day}
• /program/week

Instead we decided for three /program/* endpoints. The description of the endpoints are described in #120 (closed).

For all of them it is possible to pass a date-range as query parameters.

Proposal

We outlined some rough ideas in todays meeting:

• The main schema element may be called something like ProgramEntry.
• Existing objects are nested (e.g. ProgramEntry.timeslotPartial.{ 'id': 1, ... }) and may be only rendered partially.
• Important IDs of nested objects may also be appearing on the top-level (e.g. ProgramEntry.timeslotId), allowing us to omit certain objects.
• Here we use the term ProgramEntry.episode instead of note.
• Check other decisions in today's protocol; open design questions will be discussed when the appear.

The implementation is the basis for these follow up tickets:

• Display virtual timeslots / Station fallback sh... (dashboard#128 - closed)
• [EPIC] Web API to meet radio requirements (aura#372 - closed).

changed milestone to %1.0-alpha5 — Capable Capybara

added P1 discuss labels

assigned to @eigenwijsje

@eigenwijsje as discussed, the ticket for the program endpoint. It would be great to prioritize this ticket (along with radio settings), since this is required by @kmohrf to complete virtual timeslots in Dashboard.

mentioned in issue aura#176 (closed)

added Cycle [4/24] label

added Doing label

added size:l label

added 15h 45m of time spent

added ready-for-testing label and removed Doing label

changed title from Design and implement API endpoint "/program" to *Design and implement API endpoints "/program{+/+}"

changed the description

I'm closing this as tested since:

• Dashboard seems to be working with the basic endpoint
• Quickly verified the playout endpoint and it seems like to be a working basis for finalizing the Engine part of virtual timeslots
• Did not check calendar endpoint, but if improvements are required, we can do so in alpha-6

closed

removed ready-for-testing label

removed discuss label