*: add new base class for non-model serializers

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>

authentik/outposts/api/outpost_service_connections.py

@@ -1,17 +1,20 @@
 """Outpost API Views"""
 from dataclasses import asdict
 
-from django.db.models.base import Model
 from django.urls import reverse
 from drf_yasg.utils import swagger_auto_schema
 from rest_framework.decorators import action
 from rest_framework.fields import BooleanField, CharField, SerializerMethodField
 from rest_framework.request import Request
 from rest_framework.response import Response
-from rest_framework.serializers import ModelSerializer, Serializer
+from rest_framework.serializers import ModelSerializer
 from rest_framework.viewsets import ModelViewSet
 
-from authentik.core.api.utils import MetaNameSerializer, TypeCreateSerializer
+from authentik.core.api.utils import (
+    MetaNameSerializer,
+    PassiveSerializer,
+    TypeCreateSerializer,
+)
 from authentik.lib.templatetags.authentik_utils import verbose_name
 from authentik.lib.utils.reflection import all_subclasses
 from authentik.outposts.models import (
@@ -43,18 +46,12 @@ class ServiceConnectionSerializer(ModelSerializer, MetaNameSerializer):
         ]
 
 
-class ServiceConnectionStateSerializer(Serializer):
+class ServiceConnectionStateSerializer(PassiveSerializer):
     """Serializer for Service connection state"""
 
     healthy = BooleanField(read_only=True)
     version = CharField(read_only=True)
 
-    def create(self, validated_data: dict) -> Model:
-        raise NotImplementedError
-
-    def update(self, instance: Model, validated_data: dict) -> Model:
-        raise NotImplementedError
-
 
 class ServiceConnectionViewSet(ModelViewSet):
     """ServiceConnection Viewset"""

authentik/outposts/api/outposts.py

@@ -1,14 +1,14 @@
 """Outpost API Views"""
-from django.db.models import Model
 from drf_yasg.utils import swagger_auto_schema
 from rest_framework.decorators import action
 from rest_framework.fields import BooleanField, CharField, DateTimeField
 from rest_framework.request import Request
 from rest_framework.response import Response
-from rest_framework.serializers import JSONField, ModelSerializer, Serializer
+from rest_framework.serializers import JSONField, ModelSerializer
 from rest_framework.viewsets import ModelViewSet
 
 from authentik.core.api.providers import ProviderSerializer
+from authentik.core.api.utils import PassiveSerializer
 from authentik.outposts.models import Outpost, default_outpost_config
 
 
@@ -32,19 +32,13 @@ class OutpostSerializer(ModelSerializer):
         ]
 
 
-class OutpostDefaultConfigSerializer(Serializer):
+class OutpostDefaultConfigSerializer(PassiveSerializer):
     """Global default outpost config"""
 
     config = JSONField(read_only=True)
 
-    def create(self, validated_data: dict) -> Model:
-        raise NotImplementedError
 
-    def update(self, instance: Model, validated_data: dict) -> Model:
-        raise NotImplementedError
-
-
-class OutpostHealthSerializer(Serializer):
+class OutpostHealthSerializer(PassiveSerializer):
     """Outpost health status"""
 
     last_seen = DateTimeField(read_only=True)
@@ -52,12 +46,6 @@ class OutpostHealthSerializer(Serializer):
     version_should = CharField(read_only=True)
     version_outdated = BooleanField(read_only=True)
 
-    def create(self, validated_data: dict) -> Model:
-        raise NotImplementedError
-
-    def update(self, instance: Model, validated_data: dict) -> Model:
-        raise NotImplementedError
-
 
 class OutpostViewSet(ModelViewSet):
     """Outpost Viewset"""