Skip to content
Snippets Groups Projects
Verified Commit 7d1d94a8 authored by Ernesto Rico Schmidt's avatar Ernesto Rico Schmidt
Browse files

feat: add examples for retrieve & list schedule views

parent b8c4ecd7
No related branches found
No related tags found
No related merge requests found
...@@ -839,7 +839,28 @@ class APIRRuleViewSet(viewsets.ModelViewSet): ...@@ -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( update=extend_schema(
summary="Update an existing schedule.", summary="Update an existing schedule.",
request=ScheduleCreateUpdateRequestSerializer, request=ScheduleCreateUpdateRequestSerializer,
...@@ -849,7 +870,28 @@ class APIRRuleViewSet(viewsets.ModelViewSet): ...@@ -849,7 +870,28 @@ class APIRRuleViewSet(viewsets.ModelViewSet):
request=ScheduleCreateUpdateRequestSerializer, request=ScheduleCreateUpdateRequestSerializer,
), ),
destroy=extend_schema(summary="Delete an existing schedule."), 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): class APIScheduleViewSet(viewsets.ModelViewSet):
filterset_class = filters.ScheduleFilterSet filterset_class = filters.ScheduleFilterSet
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment