mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-25 01:48:38 -06:00
Rename 'requested_fields' kwarg to 'fields' on BaseSerializer
This commit is contained in:
parent
78e284c14f
commit
7008ffe6d8
@ -45,7 +45,7 @@ class ConsoleServerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer,
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -76,7 +76,7 @@ class ConsolePortSerializer(NetBoxModelSerializer, CabledObjectSerializer, Conne
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -107,7 +107,7 @@ class PowerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer, Connect
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -134,7 +134,7 @@ class PowerOutletSerializer(NetBoxModelSerializer, CabledObjectSerializer, Conne
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -179,7 +179,7 @@ class InterfaceSerializer(NetBoxModelSerializer, CabledObjectSerializer, Connect
|
|||||||
)
|
)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -254,7 +254,7 @@ class RearPortSerializer(NetBoxModelSerializer, CabledObjectSerializer):
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -286,7 +286,7 @@ class FrontPortSerializer(NetBoxModelSerializer, CabledObjectSerializer):
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
module = ModuleSerializer(
|
module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
|
fields=('id', 'url', 'display', 'device', 'module_bay'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
@ -308,7 +308,7 @@ class ModuleBaySerializer(NetBoxModelSerializer):
|
|||||||
device = DeviceSerializer(nested=True)
|
device = DeviceSerializer(nested=True)
|
||||||
installed_module = ModuleSerializer(
|
installed_module = ModuleSerializer(
|
||||||
nested=True,
|
nested=True,
|
||||||
requested_fields=('id', 'url', 'display', 'serial', 'description'),
|
fields=('id', 'url', 'display', 'serial', 'description'),
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True
|
allow_null=True
|
||||||
)
|
)
|
||||||
|
@ -13,18 +13,18 @@ __all__ = (
|
|||||||
class BaseModelSerializer(serializers.ModelSerializer):
|
class BaseModelSerializer(serializers.ModelSerializer):
|
||||||
display = serializers.SerializerMethodField(read_only=True)
|
display = serializers.SerializerMethodField(read_only=True)
|
||||||
|
|
||||||
def __init__(self, *args, nested=False, requested_fields=None, **kwargs):
|
def __init__(self, *args, nested=False, fields=None, **kwargs):
|
||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
|
|
||||||
self.nested = nested
|
self.nested = nested
|
||||||
|
|
||||||
if nested and not requested_fields:
|
if nested and not fields:
|
||||||
requested_fields = getattr(self.Meta, 'brief_fields', None)
|
fields = getattr(self.Meta, 'brief_fields', None)
|
||||||
|
|
||||||
# If specific fields have been requested, omit the others
|
# If specific fields have been requested, omit the others
|
||||||
if requested_fields:
|
if fields:
|
||||||
for field in list(self.fields.keys()):
|
for field in list(self.fields.keys()):
|
||||||
if field not in requested_fields:
|
if field not in fields:
|
||||||
self.fields.pop(field)
|
self.fields.pop(field)
|
||||||
|
|
||||||
def to_internal_value(self, data):
|
def to_internal_value(self, data):
|
||||||
|
@ -69,7 +69,7 @@ class BaseViewSet(GenericViewSet):
|
|||||||
|
|
||||||
# If specific fields have been requested, pass them to the serializer
|
# If specific fields have been requested, pass them to the serializer
|
||||||
if self.requested_fields:
|
if self.requested_fields:
|
||||||
kwargs['requested_fields'] = self.requested_fields
|
kwargs['fields'] = self.requested_fields
|
||||||
|
|
||||||
return super().get_serializer(*args, **kwargs)
|
return super().get_serializer(*args, **kwargs)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user