diff --git a/program/views.py b/program/views.py index 6370cc779369c43f48fdb0000ab445c8ae77608a..df98edd3b8190d79261a0c2293b2537e1cb7ff23 100644 --- a/program/views.py +++ b/program/views.py @@ -937,7 +937,38 @@ class APILicenseViewSet(viewsets.ModelViewSet): @extend_schema_view( - list=extend_schema(summary="List all settings."), + list=extend_schema( + # TODO: move this into the serializers + examples=[ + OpenApiExample( + "Example Radio Settings", + value={ + "id": 1, + "cba": {"domains": ["cba.media"]}, + "imageRequirements": { + "host.image": {"frame": {"aspectRatio": [1, 1], "shape": "round"}}, + "note.image": {"frame": {"aspectRatio": [16, 9], "shape": "round"}}, + "show.image": {"frame": {"aspectRatio": [16, 9], "shape": "round"}}, + "show.logo": {"frame": {"aspectRatio": [1, 1], "shape": "round"}}, + }, + "playout": { + "lineInChannels": {"0": "live", "1": "preprod"}, + "pools": {"fallback": "Station Fallback Pool"}, + }, + "program": { + "micro": {"showId": None}, + "fallback": {"showId": None, "defaultPool": "fallback"}, + }, + "station": { + "name": "Radio AURA", + "logo": None, + "website": "https://aura.radio", + }, + }, + ) + ], + summary="List all settings.", + ), ) class APIRadioSettingsViewSet(mixins.ListModelMixin, viewsets.GenericViewSet): queryset = RadioSettings.objects.all()