Skip to content
Snippets Groups Projects
Commit 56140d88 authored by Chris Pastl's avatar Chris Pastl
Browse files

fix: auto-gen doc params

parent 087a9385
No related branches found
No related tags found
1 merge request!45Refactor playout endpoint: fix auto-gen doc params
Pipeline #8162 passed
...@@ -280,3 +280,25 @@ class ActiveFilterSet(StaticFilterHelpTextMixin, filters.FilterSet): ...@@ -280,3 +280,25 @@ class ActiveFilterSet(StaticFilterHelpTextMixin, filters.FilterSet):
fields = [ fields = [
"is_active", "is_active",
] ]
class PlayoutFilterSet(filters.FilterSet):
start = filters.DateFilter(
field_name="start",
lookup_expr="gte",
help_text="Returns timeslots that start at or after the specified datetime "
"(default: today).",
)
end = filters.DateFilter(
field_name="end",
lookup_expr="lte",
help_text="Returns timeslots that end at or before the specified datetime "
"(default: one week after start date).",
)
include_virtual = filters.BooleanFilter(
field_name="include_virtual", help_text="Include virtual timeslots (default: false)."
)
class Meta:
model = models.TimeSlot
fields = ["start", "end", "include_virtual"]
...@@ -157,6 +157,7 @@ class APIDayScheduleViewSet( ...@@ -157,6 +157,7 @@ class APIDayScheduleViewSet(
viewsets.GenericViewSet, viewsets.GenericViewSet,
): ):
queryset = TimeSlot.objects.all() queryset = TimeSlot.objects.all()
serializer_class = TimeSlotSerializer
def list(self, request, year=None, month=None, day=None): def list(self, request, year=None, month=None, day=None):
# datetime.combine returns a timezone naive datetime object # datetime.combine returns a timezone naive datetime object
...@@ -187,11 +188,7 @@ class APIDayScheduleViewSet( ...@@ -187,11 +188,7 @@ class APIDayScheduleViewSet(
list=extend_schema( list=extend_schema(
summary="List scheduled playout.", summary="List scheduled playout.",
description=( description=(
"Returns a list of the scheduled playout." "Returns a list of the scheduled playout. "
"Expects parameters `start` (date), `end` (date), and `includeVirtual` (boolean)."
"- `start` is today by default."
"- `end` is one week after the start date by default."
"- `includeVirtual` is false by default."
"The schedule will include virtual timeslots to fill unscheduled gaps if requested." "The schedule will include virtual timeslots to fill unscheduled gaps if requested."
), ),
), ),
...@@ -201,6 +198,9 @@ class APIPlayoutViewSet( ...@@ -201,6 +198,9 @@ class APIPlayoutViewSet(
viewsets.GenericViewSet, viewsets.GenericViewSet,
): ):
queryset = TimeSlot.objects.all() queryset = TimeSlot.objects.all()
serializer_class = TimeSlotSerializer
filter_backends = [DjangoFilterBackend]
filterset_class = filters.PlayoutFilterSet
def list(self, request, *args, **kwargs): def list(self, request, *args, **kwargs):
""" """
......
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