From 7008ffe6d8e730375b7b03198d20ee09db4c230f Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 27 Feb 2024 17:01:29 -0500
Subject: [PATCH] Rename 'requested_fields' kwarg to 'fields' on BaseSerializer

---
 .../dcim/api/serializers_/device_components.py   | 16 ++++++++--------
 netbox/netbox/api/serializers/base.py            | 10 +++++-----
 netbox/netbox/api/viewsets/__init__.py           |  2 +-
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/netbox/dcim/api/serializers_/device_components.py b/netbox/dcim/api/serializers_/device_components.py
index 2e473567d..87d142978 100644
--- a/netbox/dcim/api/serializers_/device_components.py
+++ b/netbox/dcim/api/serializers_/device_components.py
@@ -45,7 +45,7 @@ class ConsoleServerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer,
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -76,7 +76,7 @@ class ConsolePortSerializer(NetBoxModelSerializer, CabledObjectSerializer, Conne
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -107,7 +107,7 @@ class PowerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer, Connect
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -134,7 +134,7 @@ class PowerOutletSerializer(NetBoxModelSerializer, CabledObjectSerializer, Conne
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -179,7 +179,7 @@ class InterfaceSerializer(NetBoxModelSerializer, CabledObjectSerializer, Connect
     )
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -254,7 +254,7 @@ class RearPortSerializer(NetBoxModelSerializer, CabledObjectSerializer):
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -286,7 +286,7 @@ class FrontPortSerializer(NetBoxModelSerializer, CabledObjectSerializer):
     device = DeviceSerializer(nested=True)
     module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'device', 'module_bay'),
+        fields=('id', 'url', 'display', 'device', 'module_bay'),
         required=False,
         allow_null=True
     )
@@ -308,7 +308,7 @@ class ModuleBaySerializer(NetBoxModelSerializer):
     device = DeviceSerializer(nested=True)
     installed_module = ModuleSerializer(
         nested=True,
-        requested_fields=('id', 'url', 'display', 'serial', 'description'),
+        fields=('id', 'url', 'display', 'serial', 'description'),
         required=False,
         allow_null=True
     )
diff --git a/netbox/netbox/api/serializers/base.py b/netbox/netbox/api/serializers/base.py
index 7fe68d4ef..bad53144e 100644
--- a/netbox/netbox/api/serializers/base.py
+++ b/netbox/netbox/api/serializers/base.py
@@ -13,18 +13,18 @@ __all__ = (
 class BaseModelSerializer(serializers.ModelSerializer):
     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)
 
         self.nested = nested
 
-        if nested and not requested_fields:
-            requested_fields = getattr(self.Meta, 'brief_fields', None)
+        if nested and not fields:
+            fields = getattr(self.Meta, 'brief_fields', None)
 
         # If specific fields have been requested, omit the others
-        if requested_fields:
+        if fields:
             for field in list(self.fields.keys()):
-                if field not in requested_fields:
+                if field not in fields:
                     self.fields.pop(field)
 
     def to_internal_value(self, data):
diff --git a/netbox/netbox/api/viewsets/__init__.py b/netbox/netbox/api/viewsets/__init__.py
index 2f0431efa..d72507e8a 100644
--- a/netbox/netbox/api/viewsets/__init__.py
+++ b/netbox/netbox/api/viewsets/__init__.py
@@ -69,7 +69,7 @@ class BaseViewSet(GenericViewSet):
 
         # If specific fields have been requested, pass them to the serializer
         if self.requested_fields:
-            kwargs['requested_fields'] = self.requested_fields
+            kwargs['fields'] = self.requested_fields
 
         return super().get_serializer(*args, **kwargs)