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

Converged API serializer for device/VM interfaces #3638

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

Originally created by @jeremystretch on GitHub (May 5, 2020).

Proposed Changes

Ditch the VM-specific InterfaceSerializer class and extend the DCIM counterpart to return both the device and virtual_machine fields.

Justification

The use of two slightly different serializers for the same model (dcim.Interface) has led to issues such as #4542 and complicates long-term maintenance. Using a single serializer should not impose any significant burden on API consumers, however this should be considered a breaking change so I'm tagging it for v2.9.

Originally created by @jeremystretch on GitHub (May 5, 2020). ### Proposed Changes Ditch the VM-specific `InterfaceSerializer` class and extend the DCIM counterpart to return both the `device` and `virtual_machine` fields. ### Justification The use of two slightly different serializers for the same model (`dcim.Interface`) has led to issues such as #4542 and complicates long-term maintenance. Using a single serializer should not impose any significant burden on API consumers, however this should be considered a breaking change so I'm tagging it for v2.9.
adam added the type: housekeepingstatus: blocked labels 2025-12-29 18:30:18 +01:00
adam closed this issue 2025-12-29 18:30:18 +01:00
adam commented 2025-12-29 18:30:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 8, 2020):

Possibly ditching this effort in favor of #4721

@jeremystretch commented on GitHub (Jun 8, 2020): Possibly ditching this effort in favor of #4721
adam commented 2025-12-29 18:30:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 23, 2020):

Ended up implementing #4721, which obviates the need for this.

@jeremystretch commented on GitHub (Jun 23, 2020): Ended up implementing #4721, which obviates the need for this.
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: blocked type: housekeeping
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#3638
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?