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

parent_device on Device is not marked as nullable in swagger api docs #9855

New Issue
Closed
opened 2025-12-29 21:23:34 +01:00 by adam · 3 comments
adam commented 2025-12-29 21:23:34 +01:00
Owner
Copy Link

Originally created by @fabi125 on GitHub (Jun 17, 2024).

Originally assigned to: @fabi125 on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.0.5

Python Version

3.10

Steps to Reproduce

  1. Go to https://demo.netbox.dev/api/schema/swagger-ui/
  2. Scroll down to Device Schema and look at the parent_device field

Expected Behavior

It should contain an annotation nullable: true.

Observed Behavior

It does not contain that annotation.

The fix for this should be to add allow_null=True to SerializerMethodField here: c8aac13cee/netbox/dcim/api/serializers_/devices.py (L60)

Happy to put up a PR but it might be easier for a maintainer to just make the change and directly merge it.

Originally created by @fabi125 on GitHub (Jun 17, 2024). Originally assigned to: @fabi125 on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.0.5 ### Python Version 3.10 ### Steps to Reproduce 1. Go to https://demo.netbox.dev/api/schema/swagger-ui/ 2. Scroll down to `Device` Schema and look at the `parent_device` field ### Expected Behavior It should contain an annotation `nullable: true`. ### Observed Behavior It does not contain that annotation. The fix for this should be to add `allow_null=True` to `SerializerMethodField` here: https://github.com/netbox-community/netbox/blob/c8aac13ceebf851368f6c7c2fbc6a783fc2e7bda/netbox/dcim/api/serializers_/devices.py#L60 Happy to put up a PR but it might be easier for a maintainer to just make the change and directly merge it.
adam added the type: bugstatus: acceptedseverity: lowtopic: OpenAPI labels 2025-12-29 21:23:35 +01:00
adam closed this issue 2025-12-29 21:23:35 +01:00
adam commented 2025-12-29 21:23:36 +01:00
Author
Owner
Copy Link

@fabi125 commented on GitHub (Jun 17, 2024):

Found a few more:

c8aac13cee/netbox/dcim/api/serializers_/base.py (L16-L17)

and

c8aac13cee/netbox/dcim/api/serializers_/cables.py (L94)

Thanks for looking at this :)

@fabi125 commented on GitHub (Jun 17, 2024): Found a few more: https://github.com/netbox-community/netbox/blob/c8aac13ceebf851368f6c7c2fbc6a783fc2e7bda/netbox/dcim/api/serializers_/base.py#L16-L17 and https://github.com/netbox-community/netbox/blob/c8aac13ceebf851368f6c7c2fbc6a783fc2e7bda/netbox/dcim/api/serializers_/cables.py#L94 Thanks for looking at this :)
adam commented 2025-12-29 21:23:36 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 17, 2024):

Thanks @fabi125, I've assigned this to you for a PR.

@jeremystretch commented on GitHub (Jun 17, 2024): Thanks @fabi125, I've assigned this to you for a PR.
adam commented 2025-12-29 21:23:37 +01:00
Author
Owner
Copy Link

@fabi125 commented on GitHub (Jul 2, 2024):

I've put up #16627 a while ago in case you missed it. Thanks!

@fabi125 commented on GitHub (Jul 2, 2024): I've put up #16627 a while ago in case you missed it. Thanks!
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 severity: low status: accepted topic: OpenAPI 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#9855
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?