starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-04-19 23:41:35 +02:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Closes #21244: Introduce ability to omit specific fields from REST API responses (#21312)

Browse Source 
Introduce support for omitting specific serializer fields via an
`omit` parameter, acting as the inverse of `fields`.
Wire it through the API viewset and queryset optimization helpers
so omitted fields don’t trigger unnecessary annotations/prefetches,
and document the new behavior.
This commit is contained in:
Jeremy Stretch
2026-01-28 16:06:46 -05:00
committed by GitHub
parent 0b507eb207
commit 1526e437f1
4 changed files with 101 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
netbox/utilities/api.py
View File

@@ -93,18 +93,23 @@ def get_view_name(view):
return drf_get_view_name(view)
def get_prefetches_for_serializer(serializer_class, fields_to_include=None):
def get_prefetches_for_serializer(serializer_class, fields=None, omit=None):
"""
Compile and return a list of fields which should be prefetched on the queryset for a serializer.
"""
if fields is not None and omit is not None:
raise TypeError("Cannot specify both 'fields' and 'omit' parameters.")
model = serializer_class.Meta.model
# If fields are not specified, default to all
if not fields_to_include:
fields_to_include = serializer_class.Meta.fields
fields_to_include = fields or serializer_class.Meta.fields
fields_to_omit = omit or []
prefetch_fields = []
for field_name in fields_to_include:
if field_name in fields_to_omit:
continue
serializer_field = serializer_class._declared_fields.get(field_name)
# Determine the name of the model field referenced by the serializer field
@@ -132,19 +137,23 @@ def get_prefetches_for_serializer(serializer_class, fields_to_include=None):
return prefetch_fields
def get_annotations_for_serializer(serializer_class, fields_to_include=None):
def get_annotations_for_serializer(serializer_class, fields=None, omit=None):
"""
Return a mapping of field names to annotations to be applied to the queryset for a serializer.
"""
annotations = {}
# If specific fields are not specified, default to all
if not fields_to_include:
fields_to_include = serializer_class.Meta.fields
if fields is not None and omit is not None:
raise TypeError("Cannot specify both 'fields' and 'omit' parameters.")
model = serializer_class.Meta.model
# If fields are not specified, default to all
fields_to_include = fields or serializer_class.Meta.fields
fields_to_omit = omit or []
annotations = {}
for field_name, field in serializer_class._declared_fields.items():
if field_name in fields_to_omit:
continue
if field_name in fields_to_include and type(field) is RelatedObjectCountField:
related_field = getattr(model, field.relation).field
annotations[field_name] = count_related(related_field.model, related_field.name)