From 7a282e23f5a8f060a7ba4b5ab1f6d19aaa463219 Mon Sep 17 00:00:00 2001
From: Mark Hoekveen <mark@hoekveen.net>
Date: Sun, 13 Jul 2025 09:45:19 +0200
Subject: [PATCH] openapi definitions for track

---
 backend/playlist/serializers/track.py | 45 +++++++++++++++++++++++++++
 backend/playlist/views/api/track.py   | 32 +++++++++++++++++++
 2 files changed, 77 insertions(+)

diff --git a/backend/playlist/serializers/track.py b/backend/playlist/serializers/track.py
index 3fe7182..a985026 100644
--- a/backend/playlist/serializers/track.py
+++ b/backend/playlist/serializers/track.py
@@ -1,6 +1,51 @@
 from playlist.models import Track
 from rest_framework import serializers
+from drf_spectacular.utils import extend_schema_serializer, OpenApiExample
 
+
+@extend_schema_serializer(
+    examples = [
+         OpenApiExample(
+            'Song with banter',
+            value={
+                "url": "http://127.0.0.1:8001/api/track/0AzD1FEuvkXP1verWfaZdv",
+                "name": "Cbat",
+                "explicit": False,
+                "duration_ms": 171720,
+                "popularity": 0,
+                "banter": "Als je denkt dat \"Cbat\" van Hudson Mohawke de soundtrack is voor het onhandig manoeuvreren van een stelletje klunzen die elkaar constant in de weg zitten, dan heb je waarschijnlijk gelijk. Dit nummer, waarin de beats net zo chaotisch zijn als de liefdesperikelen van een tiener op een eerste date, is het perfecte liedje voor iedereen die zich ooit heeft afgevraagd hoe je een kat kunt imiteren zonder dat je daadwerkelijk een kat bent.",
+                "banter_done": True,
+                "old": False,
+                "from_playlist": None,
+                "nominated_by": "http://127.0.0.1:8001/api/user/1",
+                "album": "http://127.0.0.1:8001/api/album/0d99LxnQpiPLgSGDRuU9HT",
+                "artists": [
+                    "http://127.0.0.1:8001/api/artist/6olWbKW2VLhFCHfOi0iEDb"
+                ]
+            }
+        ),
+        OpenApiExample(
+           'Song from old playlist',
+           description='While this track is from an old playlist, old is still set to False as it has been nominated again this year.',
+           value={
+                "url": "http://127.0.0.1:8001/api/track/4QGUlo1swUpXduW23JM57S",
+                "name": "You Bring On The Sun",
+                "explicit": False,
+                "duration_ms": 215400,
+                "popularity": 43,
+                "banter": None,
+                "banter_done": False,
+                "old": False,
+                "from_playlist": "HD Con 2020 A",
+                "nominated_by": None,
+                "album": "http://127.0.0.1:8001/api/album/01QglfxMtbN2EVEyGWpPyQ",
+                "artists": [
+                    "http://127.0.0.1:8001/api/artist/0gcMPgunYh4rX1UOdvZKBn"
+                ]
+            }
+       ),
+    ]
+)
 class TrackSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Track
diff --git a/backend/playlist/views/api/track.py b/backend/playlist/views/api/track.py
index 3249bf8..b3c11fd 100644
--- a/backend/playlist/views/api/track.py
+++ b/backend/playlist/views/api/track.py
@@ -4,13 +4,23 @@ from playlist.models import Track, Profile
 from playlist.serializers import TrackSerializer
 from playlist.spotify import spt
 from playlist.tasks import get_banter, get_and_dither_image
+from drf_spectacular.utils import extend_schema
 
 class TrackListView(APIView):
+    @extend_schema(
+        responses={200: TrackSerializer(many=True)},
+        description="Retrieve a list of all tracks."
+    )
     def get(self, request):
         tracks = Track.objects.all()
         serializer = TrackSerializer(tracks, many=True, context={'request': request})
         return Response(serializer.data)
 
+    @extend_schema(
+        request=None,
+        responses={201: TrackSerializer, 403: {'description': 'Forbidden'}},
+        description="Create a new track from a Spotify link."
+    )
     def post(self, request):
         (profile, _) = Profile.objects.get_or_create(user=request.user)
         (can_nom, reason) = profile.can_nominate
@@ -20,6 +30,11 @@ class TrackListView(APIView):
         serializer = TrackSerializer(track, context={'request': request})
         return Response(serializer.data)
 
+    @extend_schema(
+        request=None,
+        responses={204: None, 403: {'description': 'Forbidden'}},
+        description="Delete all tracks. Only superusers are allowed."
+    )
     def delete(self, request):
         if request.user.is_superuser:
             Track.objects.all().delete()
@@ -28,7 +43,24 @@ class TrackListView(APIView):
             return Response({'error': 'Only superusers can delete all tracks'}, status=403)
 
 class TrackDetailView(APIView):
+    @extend_schema(
+        responses={200: TrackSerializer},
+        description="Retrieve a track by its ID."
+    )
     def get(self, request, id):
         track = Track.objects.get(pk=id)
         serializer = TrackSerializer(track, context={'request': request})
         return Response(serializer.data)
+
+    @extend_schema(
+        request=None,
+        responses={204: None, 403: {'description': 'Forbidden'}},
+        description="Delete a single track by its ID. Only superusers are allowed."
+    )
+    def delete(self, request, id):
+        if request.user.is_superuser:
+            track = Track.objects.get(pk=id)
+            track.delete()
+            return Response(status=204)
+        else:
+            return Response({'error': 'Only superusers can delete tracks'}, status=403)