API versioning demo

articles/serializers.py

@@ -1,5 +1,6 @@
 from django.contrib.auth import get_user_model
 from drf_spectacular.utils import extend_schema_field
+from mitol.api_versioning.mixins import VersionedSerializerMixin
 from rest_framework import serializers
 
 from articles import models
@@ -18,13 +19,15 @@ def to_internal_value(self, data):
         return clean_html(data)
 
 
-class UserSerializer(serializers.ModelSerializer):
+class UserSerializer(VersionedSerializerMixin, serializers.ModelSerializer):
+    """Serializer for article author user fields."""
+
     class Meta:
         model = User
         fields = ["first_name", "last_name"]
 
 
-class RichTextArticleSerializer(serializers.ModelSerializer):
+class RichTextArticleSerializer(VersionedSerializerMixin, serializers.ModelSerializer):
     """
     Serializer for LearningResourceInstructor model
     """

channels/serializers.py

@@ -6,6 +6,7 @@
 from django.contrib.auth import get_user_model
 from django.db import transaction
 from drf_spectacular.utils import extend_schema_field, inline_serializer
+from mitol.api_versioning.mixins import VersionedSerializerMixin
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
 
@@ -58,7 +59,9 @@ def to_internal_value(self, data):
         return data
 
 
-class LearningPathPreviewSerializer(serializers.ModelSerializer):
+class LearningPathPreviewSerializer(
+    VersionedSerializerMixin, serializers.ModelSerializer
+):
     """Serializer for a minimal preview of Learning Paths"""
 
     class Meta:
@@ -114,7 +117,7 @@ def validate_banner(self, value):
         return {"banner": value}
 
 
-class SubChannelSerializer(serializers.ModelSerializer):
+class SubChannelSerializer(VersionedSerializerMixin, serializers.ModelSerializer):
     """Serializer for SubChannels"""
 
     parent_channel = serializers.SlugRelatedField(
@@ -160,7 +163,7 @@ class Meta:
         exclude = ["published"]
 
 
-class ChannelCountsSerializer(serializers.ModelSerializer):
+class ChannelCountsSerializer(VersionedSerializerMixin, serializers.ModelSerializer):
     """
     Serializer for resource counts associated with Channel
     """
@@ -207,7 +210,9 @@ class Meta:
         ]
 
 
-class ChannelTopicDetailSerializer(serializers.ModelSerializer):
+class ChannelTopicDetailSerializer(
+    VersionedSerializerMixin, serializers.ModelSerializer
+):
     """Serializer for the ChannelTopicDetail model"""
 
     class Meta:
@@ -222,7 +227,9 @@ class TopicChannelSerializer(ChannelBaseSerializer):
     topic_detail = ChannelTopicDetailSerializer()
 
 
-class ChannelDepartmentDetailSerializer(serializers.ModelSerializer):
+class ChannelDepartmentDetailSerializer(
+    VersionedSerializerMixin, serializers.ModelSerializer
+):
     """Serializer for the ChannelDepartmentDetail model"""
 
     class Meta:
@@ -238,7 +245,9 @@ class DepartmentChannelSerializer(ChannelBaseSerializer):
     department_detail = ChannelDepartmentDetailSerializer()
 
 
-class ChannelUnitDetailSerializer(serializers.ModelSerializer):
+class ChannelUnitDetailSerializer(
+    VersionedSerializerMixin, serializers.ModelSerializer
+):
     """Serializer for the ChannelOfferorDetail model"""
 
     unit = LearningResourceOfferorDetailSerializer(read_only=True)
@@ -256,7 +265,9 @@ class UnitChannelSerializer(ChannelBaseSerializer):
     unit_detail = ChannelUnitDetailSerializer()
 
 
-class ChannelPathwayDetailSerializer(serializers.ModelSerializer):
+class ChannelPathwayDetailSerializer(
+    VersionedSerializerMixin, serializers.ModelSerializer
+):
     """Serializer for the ChannelPathwayDetail model"""
 
     class Meta:
@@ -292,7 +303,7 @@ def to_representation(self, instance):
         return serializer_cls(instance=instance, context=self.context).data
 
 
-class ChannelCreateSerializer(serializers.ModelSerializer):
+class ChannelCreateSerializer(VersionedSerializerMixin, serializers.ModelSerializer):
     """
     Write serializer for Channel. Uses primary keys for referenced objects
     during requests, and delegates to ChannelSerializer for responses.

drf_lint_baseline.json

@@ -1,20 +1,20 @@
 [
-  "channels/serializers.py:151:32:ORM002",
-  "channels/serializers.py:186:24:ORM002",
-  "channels/serializers.py:188:24:ORM002",
-  "channels/serializers.py:190:24:ORM002",
-  "channels/serializers.py:372:28:ORM002",
-  "channels/serializers.py:374:30:ORM001",
-  "channels/serializers.py:385:12:ORM002",
-  "channels/serializers.py:394:12:ORM002",
-  "channels/serializers.py:400:29:ORM001",
-  "channels/serializers.py:412:12:ORM002",
-  "channels/serializers.py:429:16:ORM001",
-  "channels/serializers.py:433:16:ORM001",
-  "channels/serializers.py:501:12:ORM001",
-  "channels/serializers.py:509:12:ORM001",
-  "profiles/serializers.py:132:31:ORM002",
-  "profiles/serializers.py:169:16:ORM002",
-  "profiles/serializers.py:391:15:ORM001",
-  "profiles/serializers.py:392:27:ORM001"
+  "channels/serializers.py:154:32:ORM002",
+  "channels/serializers.py:189:24:ORM002",
+  "channels/serializers.py:191:24:ORM002",
+  "channels/serializers.py:193:24:ORM002",
+  "channels/serializers.py:383:28:ORM002",
+  "channels/serializers.py:385:30:ORM001",
+  "channels/serializers.py:396:12:ORM002",
+  "channels/serializers.py:405:12:ORM002",
+  "channels/serializers.py:411:29:ORM001",
+  "channels/serializers.py:423:12:ORM002",
+  "channels/serializers.py:440:16:ORM001",
+  "channels/serializers.py:444:16:ORM001",
+  "channels/serializers.py:512:12:ORM001",
+  "channels/serializers.py:520:12:ORM001",
+  "profiles/serializers.py:133:31:ORM002",
+  "profiles/serializers.py:170:16:ORM002",
+  "profiles/serializers.py:394:15:ORM001",
+  "profiles/serializers.py:395:27:ORM001"
 ]