Skip to content

16670 fix OpenAPI schema generation with nested serializers #17078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 27, 2024
Merged

16670 fix OpenAPI schema generation with nested serializers #17078

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fa0a7f
16670 fix OpenAPI schema generation with nested serializers
arthanson Aug 5, 2024
b614196
16670 fix comment
arthanson Aug 5, 2024
c992a2f
Merge branch 'develop' into 16670-nested-serializer
arthanson Aug 14, 2024
a900cf8
Add comment; misc cleanup
jeremystretch Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions netbox/core/api/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,18 @@ def get_response_serializers(self) -> typing.Any:

return response_serializers

def _get_serializer_name(self, serializer, direction, bypass_extensions=False) -> str:
name = super()._get_serializer_name(serializer, direction, bypass_extensions)

# If this serializer is nested, prepend its name with "Brief"
if getattr(serializer, 'nested', False):
name = f'Brief{name}'

return name

def get_serializer_ref_name(self, serializer):
# from drf-yasg.utils
"""Get serializer's ref_name (or None for ModelSerializer if it is named 'NestedSerializer')
"""Get serializer's ref_name
:param serializer: Serializer instance
:return: Serializer's ``ref_name`` or ``None`` for inline serializer
:rtype: str or None
Expand All @@ -137,8 +146,6 @@ def get_serializer_ref_name(self, serializer):
serializer_name = type(serializer).__name__
if hasattr(serializer_meta, 'ref_name'):
ref_name = serializer_meta.ref_name
elif serializer_name == 'NestedSerializer' and isinstance(serializer, serializers.ModelSerializer):
ref_name = None
else:
ref_name = serializer_name
if ref_name.endswith('Serializer'):
Expand Down