|
|
@@ -1,5 +1,4 @@
|
|
|
from django.contrib.contenttypes.models import ContentType
|
|
|
-from drf_spectacular.utils import extend_schema_field
|
|
|
from rest_framework import serializers
|
|
|
|
|
|
from circuits.choices import CircuitPriorityChoices, CircuitStatusChoices, VirtualCircuitTerminationRoleChoices
|
|
|
@@ -11,10 +10,12 @@ from circuits.models import (
|
|
|
from dcim.api.serializers_.device_components import InterfaceSerializer
|
|
|
from dcim.api.serializers_.cables import CabledObjectSerializer
|
|
|
from netbox.api.fields import ChoiceField, ContentTypeField, RelatedObjectCountField
|
|
|
-from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
|
|
|
+from netbox.api.gfk_fields import GFKSerializerField
|
|
|
+from netbox.api.serializers import (
|
|
|
+ NetBoxModelSerializer, OrganizationalModelSerializer, PrimaryModelSerializer, WritableNestedSerializer,
|
|
|
+)
|
|
|
from netbox.choices import DistanceUnitChoices
|
|
|
from tenancy.api.serializers_.tenants import TenantSerializer
|
|
|
-from utilities.api import get_serializer_for_model
|
|
|
from .providers import ProviderAccountSerializer, ProviderNetworkSerializer, ProviderSerializer
|
|
|
|
|
|
__all__ = (
|
|
|
@@ -29,7 +30,7 @@ __all__ = (
|
|
|
)
|
|
|
|
|
|
|
|
|
-class CircuitTypeSerializer(NetBoxModelSerializer):
|
|
|
+class CircuitTypeSerializer(OrganizationalModelSerializer):
|
|
|
|
|
|
# Related object counts
|
|
|
circuit_count = RelatedObjectCountField('circuits')
|
|
|
@@ -37,8 +38,8 @@ class CircuitTypeSerializer(NetBoxModelSerializer):
|
|
|
class Meta:
|
|
|
model = CircuitType
|
|
|
fields = [
|
|
|
- 'id', 'url', 'display_url', 'display', 'name', 'slug', 'color', 'description', 'tags', 'custom_fields',
|
|
|
- 'created', 'last_updated', 'circuit_count',
|
|
|
+ 'id', 'url', 'display_url', 'display', 'name', 'slug', 'color', 'description', 'owner', 'comments', 'tags',
|
|
|
+ 'custom_fields', 'created', 'last_updated', 'circuit_count',
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'description', 'circuit_count')
|
|
|
|
|
|
@@ -53,7 +54,7 @@ class CircuitCircuitTerminationSerializer(WritableNestedSerializer):
|
|
|
default=None
|
|
|
)
|
|
|
termination_id = serializers.IntegerField(allow_null=True, required=False, default=None)
|
|
|
- termination = serializers.SerializerMethodField(read_only=True)
|
|
|
+ termination = GFKSerializerField(read_only=True)
|
|
|
|
|
|
class Meta:
|
|
|
model = CircuitTermination
|
|
|
@@ -62,24 +63,16 @@ class CircuitCircuitTerminationSerializer(WritableNestedSerializer):
|
|
|
'upstream_speed', 'xconnect_id', 'description',
|
|
|
]
|
|
|
|
|
|
- @extend_schema_field(serializers.JSONField(allow_null=True))
|
|
|
- def get_termination(self, obj):
|
|
|
- if obj.termination_id is None:
|
|
|
- return None
|
|
|
- serializer = get_serializer_for_model(obj.termination)
|
|
|
- context = {'request': self.context['request']}
|
|
|
- return serializer(obj.termination, nested=True, context=context).data
|
|
|
-
|
|
|
|
|
|
-class CircuitGroupSerializer(NetBoxModelSerializer):
|
|
|
+class CircuitGroupSerializer(OrganizationalModelSerializer):
|
|
|
tenant = TenantSerializer(nested=True, required=False, allow_null=True)
|
|
|
circuit_count = RelatedObjectCountField('assignments')
|
|
|
|
|
|
class Meta:
|
|
|
model = CircuitGroup
|
|
|
fields = [
|
|
|
- 'id', 'url', 'display_url', 'display', 'name', 'slug', 'description', 'tenant',
|
|
|
- 'tags', 'custom_fields', 'created', 'last_updated', 'circuit_count'
|
|
|
+ 'id', 'url', 'display_url', 'display', 'name', 'slug', 'description', 'tenant', 'owner', 'comments', 'tags',
|
|
|
+ 'custom_fields', 'created', 'last_updated', 'circuit_count'
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'name')
|
|
|
|
|
|
@@ -99,7 +92,7 @@ class CircuitGroupAssignmentSerializer_(NetBoxModelSerializer):
|
|
|
brief_fields = ('id', 'url', 'display', 'group', 'priority')
|
|
|
|
|
|
|
|
|
-class CircuitSerializer(NetBoxModelSerializer):
|
|
|
+class CircuitSerializer(PrimaryModelSerializer):
|
|
|
provider = ProviderSerializer(nested=True)
|
|
|
provider_account = ProviderAccountSerializer(nested=True, required=False, allow_null=True, default=None)
|
|
|
status = ChoiceField(choices=CircuitStatusChoices, required=False)
|
|
|
@@ -115,7 +108,7 @@ class CircuitSerializer(NetBoxModelSerializer):
|
|
|
fields = [
|
|
|
'id', 'url', 'display_url', 'display', 'cid', 'provider', 'provider_account', 'type', 'status', 'tenant',
|
|
|
'install_date', 'termination_date', 'commit_rate', 'description', 'distance', 'distance_unit',
|
|
|
- 'termination_a', 'termination_z', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
|
|
|
+ 'termination_a', 'termination_z', 'owner', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
|
|
|
'assignments',
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'provider', 'cid', 'description')
|
|
|
@@ -132,7 +125,7 @@ class CircuitTerminationSerializer(NetBoxModelSerializer, CabledObjectSerializer
|
|
|
default=None
|
|
|
)
|
|
|
termination_id = serializers.IntegerField(allow_null=True, required=False, default=None)
|
|
|
- termination = serializers.SerializerMethodField(read_only=True)
|
|
|
+ termination = GFKSerializerField(read_only=True)
|
|
|
|
|
|
class Meta:
|
|
|
model = CircuitTermination
|
|
|
@@ -144,20 +137,12 @@ class CircuitTerminationSerializer(NetBoxModelSerializer, CabledObjectSerializer
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'circuit', 'term_side', 'description', 'cable', '_occupied')
|
|
|
|
|
|
- @extend_schema_field(serializers.JSONField(allow_null=True))
|
|
|
- def get_termination(self, obj):
|
|
|
- if obj.termination_id is None:
|
|
|
- return None
|
|
|
- serializer = get_serializer_for_model(obj.termination)
|
|
|
- context = {'request': self.context['request']}
|
|
|
- return serializer(obj.termination, nested=True, context=context).data
|
|
|
-
|
|
|
|
|
|
class CircuitGroupAssignmentSerializer(CircuitGroupAssignmentSerializer_):
|
|
|
member_type = ContentTypeField(
|
|
|
queryset=ContentType.objects.filter(CIRCUIT_GROUP_ASSIGNMENT_MEMBER_MODELS)
|
|
|
)
|
|
|
- member = serializers.SerializerMethodField(read_only=True)
|
|
|
+ member = GFKSerializerField(read_only=True)
|
|
|
|
|
|
class Meta:
|
|
|
model = CircuitGroupAssignment
|
|
|
@@ -167,16 +152,8 @@ class CircuitGroupAssignmentSerializer(CircuitGroupAssignmentSerializer_):
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'group', 'member_type', 'member_id', 'member', 'priority')
|
|
|
|
|
|
- @extend_schema_field(serializers.JSONField(allow_null=True))
|
|
|
- def get_member(self, obj):
|
|
|
- if obj.member_id is None:
|
|
|
- return None
|
|
|
- serializer = get_serializer_for_model(obj.member)
|
|
|
- context = {'request': self.context['request']}
|
|
|
- return serializer(obj.member, nested=True, context=context).data
|
|
|
-
|
|
|
|
|
|
-class VirtualCircuitTypeSerializer(NetBoxModelSerializer):
|
|
|
+class VirtualCircuitTypeSerializer(OrganizationalModelSerializer):
|
|
|
|
|
|
# Related object counts
|
|
|
virtual_circuit_count = RelatedObjectCountField('virtual_circuits')
|
|
|
@@ -184,13 +161,13 @@ class VirtualCircuitTypeSerializer(NetBoxModelSerializer):
|
|
|
class Meta:
|
|
|
model = VirtualCircuitType
|
|
|
fields = [
|
|
|
- 'id', 'url', 'display_url', 'display', 'name', 'slug', 'color', 'description', 'tags', 'custom_fields',
|
|
|
- 'created', 'last_updated', 'virtual_circuit_count',
|
|
|
+ 'id', 'url', 'display_url', 'display', 'name', 'slug', 'color', 'description', 'owner', 'comments', 'tags',
|
|
|
+ 'custom_fields', 'created', 'last_updated', 'virtual_circuit_count',
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'description', 'virtual_circuit_count')
|
|
|
|
|
|
|
|
|
-class VirtualCircuitSerializer(NetBoxModelSerializer):
|
|
|
+class VirtualCircuitSerializer(PrimaryModelSerializer):
|
|
|
provider_network = ProviderNetworkSerializer(nested=True)
|
|
|
provider_account = ProviderAccountSerializer(nested=True, required=False, allow_null=True, default=None)
|
|
|
type = VirtualCircuitTypeSerializer(nested=True)
|
|
|
@@ -201,7 +178,7 @@ class VirtualCircuitSerializer(NetBoxModelSerializer):
|
|
|
model = VirtualCircuit
|
|
|
fields = [
|
|
|
'id', 'url', 'display_url', 'display', 'cid', 'provider_network', 'provider_account', 'type', 'status',
|
|
|
- 'tenant', 'description', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
|
|
|
+ 'tenant', 'description', 'owner', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
|
|
|
]
|
|
|
brief_fields = ('id', 'url', 'display', 'provider_network', 'cid', 'description')
|
|
|
|