netbox/netbox/circuits/api/nested_serializers.py

import warnings

from drf_spectacular.utils import extend_schema_serializer

from circuits.models import *
from netbox.api.fields import RelatedObjectCountField
from netbox.api.serializers import WritableNestedSerializer
from .serializers_.nested import NestedProviderAccountSerializer

__all__ = [
    'NestedCircuitSerializer',
    'NestedCircuitTerminationSerializer',
    'NestedCircuitTypeSerializer',
    'NestedProviderNetworkSerializer',
    'NestedProviderSerializer',
    'NestedProviderAccountSerializer',
]

# TODO: Remove in v4.2
warnings.warn(
    f"Dedicated nested serializers will be removed in NetBox v4.2. Use Serializer(nested=True) instead.",
    DeprecationWarning
)


#
# Provider networks
#

class NestedProviderNetworkSerializer(WritableNestedSerializer):

    class Meta:
        model = ProviderNetwork
        fields = ['id', 'url', 'display_url', 'display', 'name']


#
# Providers
#

@extend_schema_serializer(
    exclude_fields=('circuit_count',),
)
class NestedProviderSerializer(WritableNestedSerializer):
    circuit_count = RelatedObjectCountField('circuits')

    class Meta:
        model = Provider
        fields = ['id', 'url', 'display_url', 'display', 'name', 'slug', 'circuit_count']


#
# Circuits
#

@extend_schema_serializer(
    exclude_fields=('circuit_count',),
)
class NestedCircuitTypeSerializer(WritableNestedSerializer):
    circuit_count = RelatedObjectCountField('circuits')

    class Meta:
        model = CircuitType
        fields = ['id', 'url', 'display_url', 'display', 'name', 'slug', 'circuit_count']


class NestedCircuitSerializer(WritableNestedSerializer):

    class Meta:
        model = Circuit
        fields = ['id', 'url', 'display_url', 'display', 'cid']


class NestedCircuitTerminationSerializer(WritableNestedSerializer):
    circuit = NestedCircuitSerializer()

    class Meta:
        model = CircuitTermination
        fields = ['id', 'url', 'display_url', 'display', 'circuit', 'term_side', 'cable', '_occupied']