mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Update Cable API serializer

Browse Source
This commit is contained in:
jeremystretch
2022-05-16 15:33:57 -04:00
parent 399afffddf
commit 1505369133
3 changed files with 49 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
netbox/dcim/api/serializers.py
View File

@ -6,6 +6,7 @@ from timezone_field.rest_framework import TimeZoneSerializerField
from dcim.choices import * from dcim.choices import *
from dcim.constants import * from dcim.constants import *
from dcim.models import * from dcim.models import *
from extras.api.serializers import ContentTypeSerializer
from ipam.api.nested_serializers import ( from ipam.api.nested_serializers import (
NestedASNSerializer, NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer, NestedASNSerializer, NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer,
) )
@ -994,8 +995,10 @@ class InventoryItemRoleSerializer(NetBoxModelSerializer):
class CableSerializer(NetBoxModelSerializer): class CableSerializer(NetBoxModelSerializer):
url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail')
# termination_a = serializers.SerializerMethodField(read_only=True) a_terminations_type = serializers.SerializerMethodField(read_only=True)
# termination_b = serializers.SerializerMethodField(read_only=True) b_terminations_type = serializers.SerializerMethodField(read_only=True)
a_terminations = serializers.SerializerMethodField(read_only=True)
b_terminations = serializers.SerializerMethodField(read_only=True)
status = ChoiceField(choices=LinkStatusChoices, required=False) status = ChoiceField(choices=LinkStatusChoices, required=False)
tenant = NestedTenantSerializer(required=False, allow_null=True) tenant = NestedTenantSerializer(required=False, allow_null=True)
length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False) length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False)
@ -1003,30 +1006,46 @@ class CableSerializer(NetBoxModelSerializer):
class Meta: class Meta:
model = Cable model = Cable
fields = [ fields = [
'id', 'url', 'display', 'type', 'status', 'tenant', 'label', 'color', 'id', 'url', 'display', 'type', 'a_terminations_type', 'a_terminations', 'b_terminations_type',
'length', 'length_unit', 'tags', 'custom_fields', 'created', 'last_updated', 'b_terminations', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', 'custom_fields',
'created', 'last_updated',
] ]
def _get_termination(self, obj, side): def _get_terminations_type(self, obj, side):
"""
Serialize a nested representation of a termination.
"""
assert side.lower() in ('a', 'b') assert side.lower() in ('a', 'b')
termination_type = getattr(obj, f'termination_{side}_type').model_class() terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()]
termination = getattr(obj, f'termination_{side}') if terms:
serializer = get_serializer_for_model(termination_type, prefix='Nested') ct = ContentType.objects.get_for_model(terms[0])
return f"{ct.app_label}.{ct.model}"
def _get_terminations(self, obj, side):
assert side.lower() in ('a', 'b')
terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()]
if not terms:
return []
termination_type = ContentType.objects.get_for_model(terms[0])
serializer = get_serializer_for_model(termination_type.model_class(), prefix='Nested')
context = {'request': self.context['request']} context = {'request': self.context['request']}
data = serializer(termination, context=context, many=True).data data = serializer(terms, context=context, many=True).data
return data return data
@swagger_serializer_method(serializer_or_field=serializers.DictField) @swagger_serializer_method(serializer_or_field=serializers.CharField)
def get_termination_a(self, obj): def get_a_terminations_type(self, obj):
return self._get_termination(obj, 'a') return self._get_terminations_type(obj, 'a')
@swagger_serializer_method(serializer_or_field=serializers.CharField)
def get_b_terminations_type(self, obj):
return self._get_terminations_type(obj, 'b')
@swagger_serializer_method(serializer_or_field=serializers.DictField) @swagger_serializer_method(serializer_or_field=serializers.DictField)
def get_termination_b(self, obj): def get_a_terminations(self, obj):
return self._get_termination(obj, 'b') return self._get_terminations(obj, 'a')
@swagger_serializer_method(serializer_or_field=serializers.DictField)
def get_b_terminations(self, obj):
return self._get_terminations(obj, 'b')
class TracedCableSerializer(serializers.ModelSerializer): class TracedCableSerializer(serializers.ModelSerializer):

2
netbox/dcim/api/views.py
View File

@ -647,7 +647,7 @@ class InventoryItemRoleViewSet(NetBoxModelViewSet):
class CableViewSet(NetBoxModelViewSet): class CableViewSet(NetBoxModelViewSet):
metadata_class = ContentTypeMetadata metadata_class = ContentTypeMetadata
queryset = Cable.objects.all() queryset = Cable.objects.prefetch_related('terminations__termination')
serializer_class = serializers.CableSerializer serializer_class = serializers.CableSerializer
filterset_class = filtersets.CableFilterSet filterset_class = filtersets.CableFilterSet

24
netbox/dcim/tests/test_api.py
View File

@ -1888,24 +1888,24 @@ class CableTest(APIViewTestCases.APIViewTestCase):
cls.create_data = [ cls.create_data = [
{ {
'termination_a_type': 'dcim.interface', 'a_terminations_type': 'dcim.interface',
'termination_a_id': interfaces[4].pk, 'a_terminations': [interfaces[4].pk],
'termination_b_type': 'dcim.interface', 'b_terminations_type': 'dcim.interface',
'termination_b_id': interfaces[14].pk, 'b_terminations': [interfaces[14].pk],
'label': 'Cable 4', 'label': 'Cable 4',
}, },
{ {
'termination_a_type': 'dcim.interface', 'a_terminations_type': 'dcim.interface',
'termination_a_id': interfaces[5].pk, 'a_terminations': [interfaces[5].pk],
'termination_b_type': 'dcim.interface', 'b_terminations_type': 'dcim.interface',
'termination_b_id': interfaces[15].pk, 'b_terminations': [interfaces[15].pk],
'label': 'Cable 5', 'label': 'Cable 5',
}, },
{ {
'termination_a_type': 'dcim.interface', 'a_terminations_type': 'dcim.interface',
'termination_a_id': interfaces[6].pk, 'a_terminations': [interfaces[6].pk],
'termination_b_type': 'dcim.interface', 'b_terminations_type': 'dcim.interface',
'termination_b_id': interfaces[16].pk, 'b_terminations': [interfaces[16].pk],
'label': 'Cable 6', 'label': 'Cable 6',
}, },
] ]