Valid schema for "/steering/api/v1/playout" endpoint

changed milestone to %1.0-alpha3 — Playful Platypus

added P3 label

marked this issue as related to engine#129 (closed)

changed the description

If we want to keep the endpoint filling the gaps in the timeline, we will need to fill them with an object that looks like an actual entry for this to work according to an OpenAPI specification.

This means that the engine would need to recognize these entries and handle them differently and this means that we would need to hard-code this on both sides.

The alternative would be to change the API and provide both types of entries (actual timeslots and a gap filling entries) in two separate lists.

We need to discuss this further.

I understand, but the filling of gaps feature with virtual timeslots is not yet complete, that we can use it anyway. This concept should not only applied to the /playout endpoint but also to the endpoints which Dashboard is using (to display the gaps), plus the endpoints which are used on the website.

Otherwise it does not utilize its purpose to its full extend: Generate the virtual timeslots once (Steering) - use them everywhere.

But I guess that you are referring to the fact, that the /playout endpoint is currently returning virtual timeslots with a limited schema/properties:

  {
    "start": "2023-02-20T05:00:00",
    "end": "2023-02-20T11:00:00",
    "virtual": true
  }

In contrast to "real" timeslots:

  {
    "id": 372,
    "start": "2023-02-20T04:00:00",
    "end": "2023-02-20T05:00:00",
    "title": "AURA",
    "schedule_id": 2,
    "is_repetition": false,
    "playlist_id": null,
    "schedule_default_playlist_id": null,
    "show_default_playlist_id": null,
    "show_id": 2,
    "show_name": "AURA",
    "show_hosts": "Musikredaktion",
    "show_type": "Unmoderiertes Musikprogramm",
    "show_categories": "Mehr-/Fremdsprachig",
    "show_topics": "Wissenschaft/Philosophie",
    "show_musicfocus": "Experimentelle Musik",
    "show_languages": "Deutsch, Spanisch",
    "show_fundingcategory": "",
    "memo": "",
    "className": "danger"
  }

Engine actually needs all the details like a Show and Note details, that it can provide proper playlogs. This should be derived from a so-called "Station Fallback Show" in Steering. Actually in the early days of AURA there was such a property in Steering added by Ingo. At this point it was only a stub, with no logic yet. But we where not thinking far enough and thought it might be more simple to remove this setting at first.

So what is missing, that we add a way to configure such "Station Fallback Show" in Steering.

As soon you have such information in Steering, you can populate virtual timeslots the same way as ordinary timeslots. And also the schema can be validated easily.

What do you think about that, do you agree?

added discuss label

marked this issue as related to #120 (closed)

mentioned in issue engine#131

removed P3 label

added P1 label

added 1 deleted label

added To Do label

Apparently, OpenAPI 3 supports this: https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/ and I think this can be done with https://django-polymorphic.readthedocs.io/en/stable/index.html

Team 2023-07-13: We decided to implement this, after the Virtual Timeslots are done (see aura#176 (closed)):

changed milestone to %1.0-alpha5 — Capable Capybara

removed 1 deleted label

removed discuss label

Valid schema for "/steering/api/v1/playout" endpoint

Parent: [EPIC] Future-proof AURA API (aura#192 - closed)

Related

Designs

Child items ...

Activity