refactor schedule REST API

This MR makes a few changes to the schedule REST API:

• It removes deprecated schedule attribute names (dstart, until, tstart, tend, and byweekday) and replaces them with the attribute names from the Schedule model (first_date, last_date, time_start, time_end, and by_weekday).
• It removes the special handling of schedule requests without a solutions object. Instead, clients can omit the solutions object and if no conflicts are detected the schedule is simply created. This avoids race conditions in the client and simplifies our view code a bit.
• Schedule conflict responses are now returned with an HTTP 409 status code.

Fixes #101 (closed).

I will open another MR in the dashboard project that implements the necessary changes there.

program/views.py

@@ -42,6 +42,7 @@ from program.models import (
     MusicFocus,
     Note,
     Schedule,
+    ScheduleConflictError,
     Show,
     TimeSlot,
     Topic,
@@ -58,6 +59,7 @@ from program.serializers import (
     ScheduleConflictResponseSerializer,
     ScheduleCreateUpdateRequestSerializer,
     ScheduleDryRunResponseSerializer,
+    ScheduleResponseSerializer,
     ScheduleSerializer,
     ShowSerializer,
     TimeSlotSerializer,
@@ -344,9 +346,10 @@ class APIShowViewSet(DisabledObjectPermissionCheckMixin, viewsets.ModelViewSet):
 @extend_schema_view(
     create=extend_schema(
         summary="Create a new schedule.",
+        request=ScheduleCreateUpdateRequestSerializer,
         responses={
             status.HTTP_201_CREATED: OpenApiResponse(
-                response=ScheduleConflictResponseSerializer,
+                response=ScheduleResponseSerializer,
                 description=(
                     "Signals the successful creation of the schedule and of the projected "
                     "timeslots."
@@ -366,9 +369,9 @@ class APIShowViewSet(DisabledObjectPermissionCheckMixin, viewsets.ModelViewSet):
                     Returned in case the request contained invalid data.
 
                     This may happen if:
-                    * the until date is before the start date (`no-start-after-end`),
+                    * the last date is before the start date (`no-start-after-end`),
                       in which case you should correct either the start or until date.
-                    * The start and until date are the same (`no-same-day-start-and-end`).
+                    * The start and last date are the same (`no-same-day-start-and-end`).
                       This is only allowed for single timeslots with the recurrence rule
                       set to `once`. You should fix either the start or until date.
                     * The number of conflicts and solutions aren’t the same
@@ -410,8 +413,14 @@ class APIShowViewSet(DisabledObjectPermissionCheckMixin, viewsets.ModelViewSet):
         },
     ),
     retrieve=extend_schema(summary="Retrieve a single schedule."),
-    update=extend_schema(summary="Update an existing schedule."),
-    partial_update=extend_schema(summary="Partially update an existing schedule."),
+    update=extend_schema(
+        summary="Update an existing schedule.",
+        request=ScheduleCreateUpdateRequestSerializer,
+    ),
+    partial_update=extend_schema(
+        summary="Partially update an existing schedule.",
+        request=ScheduleCreateUpdateRequestSerializer,
+    ),
     destroy=extend_schema(summary="Delete an existing schedule."),
     list=extend_schema(summary="List all schedules."),
 )
@@ -475,28 +484,16 @@ class APIScheduleViewSet(
         if show_pk is None or "schedule" not in request.data:
             return Response(status=status.HTTP_400_BAD_REQUEST)
 
-        # First create submit -> return projected timeslots and collisions
-        # TODO: Perhaps directly insert into database if no conflicts found
-        if "solutions" not in request.data:
-            # TODO: respond with status.HTTP_409_CONFLICT when the dashboard can handle it
-            return Response(
-                Schedule.make_conflicts(request.data["schedule"], pk, show_pk),
-            )
-
-        # Otherwise try to resolve
-        resolution = Schedule.resolve_conflicts(request.data, pk, show_pk)
+        try:
+            resolution = Schedule.resolve_conflicts(request.data, pk, show_pk)
+        except ScheduleConflictError as exc:
+            return Response(exc.conflicts, status.HTTP_409_CONFLICT)
 
         if all(key in resolution for key in ["create", "update", "delete"]):
             # this is a dry-run
             return Response(resolution, status=status.HTTP_202_ACCEPTED)
 
-        # If resolution went well
-        if "projected" not in resolution:
-            return Response(resolution, status=status.HTTP_201_CREATED)
-
-        # Otherwise return conflicts
-        # TODO: respond with status.HTTP_409_CONFLICT when the dashboard can handle it
-        return Response(resolution)
+        return Response(resolution, status=status.HTTP_201_CREATED)
 
     def update(self, request, *args, **kwargs):
         """
@@ -532,26 +529,13 @@ class APIScheduleViewSet(
             serializer = ScheduleSerializer(schedule)
             return Response(serializer.data)
 
-        # First update submit -> return projected timeslots and collisions
-        if "solutions" not in request.data:
-            # TODO: respond with status.HTTP_409_CONFLICT when the dashboard can handle it
-            return Response(
-                Schedule.make_conflicts(
-                    request.data["schedule"], schedule.pk, schedule.show.pk
-                )
+        try:
+            resolution = Schedule.resolve_conflicts(
+                request.data, schedule.pk, schedule.show.pk
             )
+        except ScheduleConflictError as exc:
+            return Response(exc.conflicts, status.HTTP_409_CONFLICT)
 
-        # Otherwise try to resolve
-        resolution = Schedule.resolve_conflicts(
-            request.data, schedule.pk, schedule.show.pk
-        )
-
-        # If resolution went well
-        if "projected" not in resolution:
-            return Response(resolution)
-
-        # Otherwise return conflicts
-        # TODO: respond with status.HTTP_409_CONFLICT when the dashboard can handle it
         return Response(resolution)
 
     def destroy(self, request, *args, **kwargs):