starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add missing Serializer annotations #6916

New Issue
Closed
opened 2025-12-29 19:46:40 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:46:40 +01:00
Owner
Copy Link

Originally created by @amhn on GitHub (Aug 31, 2022).

Originally assigned to: @amhn on GitHub.

NetBox version

v3.3.1

Python version

3.10

Steps to Reproduce

  1. Download swagger.json
  2. GET request on /api/ipam/vlan-groups/{ID} on vlan groups with sope

Expected Behavior

API documentation and returned object use same types.

Observed Behavior

Swagger.json list field sope as type string, field in returned object is JSON

Originally created by @amhn on GitHub (Aug 31, 2022). Originally assigned to: @amhn on GitHub. ### NetBox version v3.3.1 ### Python version 3.10 ### Steps to Reproduce 1. Download swagger.json 2. GET request on /api/ipam/vlan-groups/{ID} on vlan groups with sope ### Expected Behavior API documentation and returned object use same types. ### Observed Behavior Swagger.json list field sope as type string, field in returned object is JSON
adam added the type: bugstatus: accepted labels 2025-12-29 19:46:40 +01:00
adam closed this issue 2025-12-29 19:46:40 +01:00
adam commented 2025-12-29 19:46:41 +01:00
Author
Owner
Copy Link

@amhn commented on GitHub (Aug 31, 2022):

Proposed fix: Add missing serailizer annotations. The diff adds them to all objects I could identify where the type returned is not string. Only VlanGoup.scope is currently displayed in swagger.json.

diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py
index 533238d36..764c7750a 100644
--- a/netbox/extras/api/serializers.py
+++ b/netbox/extras/api/serializers.py
@@ -403,6 +403,7 @@ class ScriptSerializer(serializers.Serializer):
     vars = serializers.SerializerMethodField(read_only=True)
     result = NestedJobResultSerializer()
 
+    @swagger_serializer_method(serializer_or_field=serializers.JSONField)
     def get_vars(self, instance):
         return {
             k: v.__class__.__name__ for k, v in instance._get_vars().items()
diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py
index 6244e5f04..fa8b563e9 100644
--- a/netbox/ipam/api/serializers.py
+++ b/netbox/ipam/api/serializers.py
@@ -190,6 +190,7 @@ class VLANGroupSerializer(NetBoxModelSerializer):
         ]
         validators = []
 
+    @swagger_serializer_method(serializer_or_field=serializers.JSONField)
     def get_scope(self, obj):
         if obj.scope_id is None:
             return None
diff --git a/netbox/users/api/nested_serializers.py b/netbox/users/api/nested_serializers.py
index e9e730cc4..0d8f7ae42 100644
--- a/netbox/users/api/nested_serializers.py
+++ b/netbox/users/api/nested_serializers.py
@@ -1,5 +1,6 @@
 from django.contrib.auth.models import Group, User
 from django.contrib.contenttypes.models import ContentType
+from drf_yasg.utils import swagger_serializer_method
 from rest_framework import serializers
 
 from netbox.api.fields import ContentTypeField
@@ -56,8 +57,10 @@ class NestedObjectPermissionSerializer(WritableNestedSerializer):
         model = ObjectPermission
         fields = ['id', 'url', 'display', 'name', 'enabled', 'object_types', 'groups', 'users', 'actions']
 
+    @swagger_serializer_method(serializer_or_field=serializers.ListField)
     def get_groups(self, obj):
         return [g.name for g in obj.groups.all()]
 
+    @swagger_serializer_method(serializer_or_field=serializers.ListField)
     def get_users(self, obj):
         return [u.username for u in obj.users.all()]

swagger.json diff:

*** swagger.orig.json   2022-08-31 20:51:08.293884289 +0200
--- swagger.new.json    2022-08-31 20:50:10.702636759 +0200
***************
*** 13184,13192 ****
                  },
                "scope" : { 
                    "readOnly" : true,
                    "title" : "Scope",
!                   "type" : "string"
                  },
                "scope_id" : { 
                    "title" : "Scope id",
                    "type" : "integer",
--- 13184,13192 ----
                  },
                "scope" : { 
                    "readOnly" : true,
                    "title" : "Scope",
!                   "type" : "object"
                  },
                "scope_id" : { 
                    "title" : "Scope id",
                    "type" : "integer",
@amhn commented on GitHub (Aug 31, 2022): Proposed fix: Add missing serailizer annotations. The diff adds them to all objects I could identify where the type returned is not string. Only VlanGoup.scope is currently displayed in swagger.json. ``` diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 533238d36..764c7750a 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -403,6 +403,7 @@ class ScriptSerializer(serializers.Serializer): vars = serializers.SerializerMethodField(read_only=True) result = NestedJobResultSerializer() + @swagger_serializer_method(serializer_or_field=serializers.JSONField) def get_vars(self, instance): return { k: v.__class__.__name__ for k, v in instance._get_vars().items() diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 6244e5f04..fa8b563e9 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -190,6 +190,7 @@ class VLANGroupSerializer(NetBoxModelSerializer): ] validators = [] + @swagger_serializer_method(serializer_or_field=serializers.JSONField) def get_scope(self, obj): if obj.scope_id is None: return None diff --git a/netbox/users/api/nested_serializers.py b/netbox/users/api/nested_serializers.py index e9e730cc4..0d8f7ae42 100644 --- a/netbox/users/api/nested_serializers.py +++ b/netbox/users/api/nested_serializers.py @@ -1,5 +1,6 @@ from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType +from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers from netbox.api.fields import ContentTypeField @@ -56,8 +57,10 @@ class NestedObjectPermissionSerializer(WritableNestedSerializer): model = ObjectPermission fields = ['id', 'url', 'display', 'name', 'enabled', 'object_types', 'groups', 'users', 'actions'] + @swagger_serializer_method(serializer_or_field=serializers.ListField) def get_groups(self, obj): return [g.name for g in obj.groups.all()] + @swagger_serializer_method(serializer_or_field=serializers.ListField) def get_users(self, obj): return [u.username for u in obj.users.all()] ``` swagger.json diff: ``` *** swagger.orig.json 2022-08-31 20:51:08.293884289 +0200 --- swagger.new.json 2022-08-31 20:50:10.702636759 +0200 *************** *** 13184,13192 **** }, "scope" : { "readOnly" : true, "title" : "Scope", ! "type" : "string" }, "scope_id" : { "title" : "Scope id", "type" : "integer", --- 13184,13192 ---- }, "scope" : { "readOnly" : true, "title" : "Scope", ! "type" : "object" }, "scope_id" : { "title" : "Scope id", "type" : "integer", ```
adam commented 2025-12-29 19:46:41 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 1, 2022):

@amhn I'm going to assign this to you since it appears you've already done the necessary work. Please let me know if you're not able to take this though and I'll remove you.

@jeremystretch commented on GitHub (Sep 1, 2022): @amhn I'm going to assign this to you since it appears you've already done the necessary work. Please let me know if you're not able to take this though and I'll remove you.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6916
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?