From 7d1d94a82b285d1ede54ab08f3f8c3b075df8619 Mon Sep 17 00:00:00 2001
From: Ernesto Rico Schmidt <ernesto@helsinki.at>
Date: Fri, 9 Aug 2024 17:25:17 -0400
Subject: [PATCH] feat: add examples for retrieve & list schedule views
---
program/views.py | 46 ++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 44 insertions(+), 2 deletions(-)
diff --git a/program/views.py b/program/views.py
index dcfc03ea..9a16798b 100644
--- a/program/views.py
+++ b/program/views.py
@@ -839,7 +839,28 @@ class APIRRuleViewSet(viewsets.ModelViewSet):
),
},
),
- retrieve=extend_schema(summary="Retrieve a single schedule."),
+ retrieve=extend_schema(
+ examples=[
+ OpenApiExample(
+ "Example single schedule",
+ value={
+ "addBusinessDaysOnly": False,
+ "addDaysNo": None,
+ "byWeekday": 0,
+ "defaultPlaylistId": None,
+ "endTime": "18:30:00",
+ "firstDate": "2024-01-08",
+ "id": 8,
+ "isRepetition": False,
+ "lastDate": "2024-12-20",
+ "rruleId": 3,
+ "showId": 8,
+ "startTime": "15:30:00",
+ },
+ )
+ ],
+ summary="Retrieve a single schedule.",
+ ),
update=extend_schema(
summary="Update an existing schedule.",
request=ScheduleCreateUpdateRequestSerializer,
@@ -849,7 +870,28 @@ class APIRRuleViewSet(viewsets.ModelViewSet):
request=ScheduleCreateUpdateRequestSerializer,
),
destroy=extend_schema(summary="Delete an existing schedule."),
- list=extend_schema(summary="List all schedules."),
+ list=extend_schema(
+ examples=[
+ OpenApiExample(
+ "Example list of schedules",
+ value={
+ "addBusinessDaysOnly": False,
+ "addDaysNo": None,
+ "byWeekday": 0,
+ "defaultPlaylistId": None,
+ "endTime": "18:30:00",
+ "firstDate": "2024-01-08",
+ "id": 8,
+ "isRepetition": False,
+ "lastDate": "2024-12-20",
+ "rruleId": 3,
+ "showId": 8,
+ "startTime": "15:30:00",
+ },
+ )
+ ],
+ summary="List all schedules.",
+ ),
)
class APIScheduleViewSet(viewsets.ModelViewSet):
filterset_class = filters.ScheduleFilterSet
--
GitLab