Skip to content
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

Allow primary key for nested models in OpenAPI request schemas #18451

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Allow primary key for nested models in OpenAPI request schemas #18451

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c535923
Fix request OpenAPI schemas for nested models
Jan 21, 2025
601211c
Add none check
Jan 22, 2025
e97dbe4
Change PK type to int
Jan 22, 2025
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
20 changes: 20 additions & 0 deletions netbox/core/api/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,3 +277,23 @@ def map_serializer_field(self, auto_schema, direction):
return component.ref if component else None
else:
return build_basic_type(OpenApiTypes.INT)


# Nested models can be passed by ID in requests
# The logic for this is handled in `BaseModelSerializer.to_internal_value`
class FixWritableNestedSerializerAllowPK(OpenApiSerializerFieldExtension):
target_class = 'netbox.api.serializers.BaseModelSerializer'
match_subclasses = True

def map_serializer_field(self, auto_schema, direction):
schema = auto_schema._map_serializer_field(self.target, direction, bypass_extensions=True)
if schema is None:
return schema
if direction == 'request' and self.target.nested:
return {
'oneOf': [
build_basic_type(OpenApiTypes.INT),
schema,
]
}
return schema
Loading