Add dynamic nesting support to SerializedPKRelatedField

netbox/extras/api/serializers.py

@@ -8,7 +8,8 @@ from .serializers_.dashboard import *
 from .serializers_.events import *
 from .serializers_.exporttemplates import *
 from .serializers_.journaling import *
-from .serializers_.provisioning import *
+from .serializers_.configcontexts import *
+from .serializers_.configtemplates import *
 from .serializers_.savedfilters import *
 from .serializers_.scripts import *
 from .serializers_.tags import *

netbox/extras/api/serializers_/configcontexts.py

@@ -1,25 +1,21 @@
 from rest_framework import serializers
 
 from core.api.serializers_.data import DataFileSerializer, DataSourceSerializer
-from dcim.api.nested_serializers import (
-    NestedDeviceRoleSerializer, NestedDeviceTypeSerializer, NestedLocationSerializer, NestedPlatformSerializer,
-    NestedRegionSerializer, NestedSiteSerializer, NestedSiteGroupSerializer,
-)
+from dcim.api.serializers_.devicetypes import DeviceTypeSerializer
+from dcim.api.serializers_.platforms import PlatformSerializer
+from dcim.api.serializers_.roles import DeviceRoleSerializer
+from dcim.api.serializers_.sites import LocationSerializer, RegionSerializer, SiteSerializer, SiteGroupSerializer
 from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup
-from extras.models import ConfigContext, ConfigTemplate, Tag
+from extras.models import ConfigContext, Tag
 from netbox.api.fields import SerializedPKRelatedField
 from netbox.api.serializers import ValidatedModelSerializer
-from netbox.api.serializers.features import TaggableModelSerializer
-from tenancy.api.nested_serializers import NestedTenantSerializer, NestedTenantGroupSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer, TenantGroupSerializer
 from tenancy.models import Tenant, TenantGroup
-from virtualization.api.nested_serializers import (
-    NestedClusterGroupSerializer, NestedClusterSerializer, NestedClusterTypeSerializer,
-)
+from virtualization.api.serializers_.clusters import ClusterSerializer, ClusterGroupSerializer, ClusterTypeSerializer
 from virtualization.models import Cluster, ClusterGroup, ClusterType
 
 __all__ = (
     'ConfigContextSerializer',
-    'ConfigTemplateSerializer',
 )
 
 
@@ -27,73 +23,85 @@ class ConfigContextSerializer(ValidatedModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='extras-api:configcontext-detail')
     regions = SerializedPKRelatedField(
         queryset=Region.objects.all(),
-        serializer=NestedRegionSerializer,
+        serializer=RegionSerializer,
+        nested=True,
         required=False,
         many=True
     )
     site_groups = SerializedPKRelatedField(
         queryset=SiteGroup.objects.all(),
-        serializer=NestedSiteGroupSerializer,
+        serializer=SiteGroupSerializer,
+        nested=True,
         required=False,
         many=True
     )
     sites = SerializedPKRelatedField(
         queryset=Site.objects.all(),
-        serializer=NestedSiteSerializer,
+        serializer=SiteSerializer,
+        nested=True,
         required=False,
         many=True
     )
     locations = SerializedPKRelatedField(
         queryset=Location.objects.all(),
-        serializer=NestedLocationSerializer,
+        serializer=LocationSerializer,
+        nested=True,
         required=False,
         many=True
     )
     device_types = SerializedPKRelatedField(
         queryset=DeviceType.objects.all(),
-        serializer=NestedDeviceTypeSerializer,
+        serializer=DeviceTypeSerializer,
+        nested=True,
         required=False,
         many=True
     )
     roles = SerializedPKRelatedField(
         queryset=DeviceRole.objects.all(),
-        serializer=NestedDeviceRoleSerializer,
+        serializer=DeviceRoleSerializer,
+        nested=True,
         required=False,
         many=True
     )
     platforms = SerializedPKRelatedField(
         queryset=Platform.objects.all(),
-        serializer=NestedPlatformSerializer,
+        serializer=PlatformSerializer,
+        nested=True,
         required=False,
         many=True
     )
     cluster_types = SerializedPKRelatedField(
         queryset=ClusterType.objects.all(),
-        serializer=NestedClusterTypeSerializer,
+        serializer=ClusterTypeSerializer,
+        nested=True,
         required=False,
         many=True
     )
     cluster_groups = SerializedPKRelatedField(
         queryset=ClusterGroup.objects.all(),
-        serializer=NestedClusterGroupSerializer,
+        serializer=ClusterGroupSerializer,
+        nested=True,
         required=False,
         many=True
     )
     clusters = SerializedPKRelatedField(
         queryset=Cluster.objects.all(),
-        serializer=NestedClusterSerializer,
+        serializer=ClusterSerializer,
+        nested=True,
         required=False,
         many=True
     )
     tenant_groups = SerializedPKRelatedField(
         queryset=TenantGroup.objects.all(),
-        serializer=NestedTenantGroupSerializer,
+        serializer=TenantGroupSerializer,
+        nested=True,
         required=False,
         many=True
     )
     tenants = SerializedPKRelatedField(
         queryset=Tenant.objects.all(),
-        serializer=NestedTenantSerializer,
+        serializer=TenantSerializer,
+        nested=True,
         required=False,
         many=True
     )
@@ -121,27 +129,3 @@ class ConfigContextSerializer(ValidatedModelSerializer):
             'created', 'last_updated',
         ]
         brief_fields = ('id', 'url', 'display', 'name', 'description')
-
-
-#
-# Config templates
-#
-
-class ConfigTemplateSerializer(TaggableModelSerializer, ValidatedModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name='extras-api:configtemplate-detail')
-    data_source = DataSourceSerializer(
-        nested=True,
-        required=False
-    )
-    data_file = DataFileSerializer(
-        nested=True,
-        required=False
-    )
-
-    class Meta:
-        model = ConfigTemplate
-        fields = [
-            'id', 'url', 'display', 'name', 'description', 'environment_params', 'template_code', 'data_source',
-            'data_path', 'data_file', 'data_synced', 'tags', 'created', 'last_updated',
-        ]
-        brief_fields = ('id', 'url', 'display', 'name', 'description')

netbox/extras/api/serializers_/configtemplates.py

@@ -0,0 +1,30 @@
+from rest_framework import serializers
+
+from core.api.serializers_.data import DataFileSerializer, DataSourceSerializer
+from extras.models import ConfigTemplate
+from netbox.api.serializers import ValidatedModelSerializer
+from netbox.api.serializers.features import TaggableModelSerializer
+
+__all__ = (
+    'ConfigTemplateSerializer',
+)
+
+
+class ConfigTemplateSerializer(TaggableModelSerializer, ValidatedModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='extras-api:configtemplate-detail')
+    data_source = DataSourceSerializer(
+        nested=True,
+        required=False
+    )
+    data_file = DataFileSerializer(
+        nested=True,
+        required=False
+    )
+
+    class Meta:
+        model = ConfigTemplate
+        fields = [
+            'id', 'url', 'display', 'name', 'description', 'environment_params', 'template_code', 'data_source',
+            'data_path', 'data_file', 'data_synced', 'tags', 'created', 'last_updated',
+        ]
+        brief_fields = ('id', 'url', 'display', 'name', 'description')

netbox/extras/api/serializers_/events.py

@@ -9,7 +9,7 @@ from netbox.api.fields import ChoiceField, ContentTypeField
 from netbox.api.serializers import NetBoxModelSerializer
 from netbox.constants import NESTED_SERIALIZER_PREFIX
 from utilities.api import get_serializer_for_model
-from ..nested_serializers import *
+from .scripts import ScriptSerializer
 
 __all__ = (
     'EventRuleSerializer',
@@ -49,7 +49,7 @@ class EventRuleSerializer(NetBoxModelSerializer):
         if instance.action_type == EventRuleActionChoices.SCRIPT:
             script = instance.action_object
             instance = script.python_class() if script.python_class else None
-            return NestedScriptSerializer(instance, context=context).data
+            return ScriptSerializer(instance, nested=True, context=context).data
         else:
             serializer = get_serializer_for_model(
                 model=instance.action_object_type.model_class(),