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

Move nested API serializers to a separate file within each app #2115

New Issue
Closed
opened 2025-12-29 17:22:25 +01:00 by adam · 0 comments
adam commented 2025-12-29 17:22:25 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Nov 9, 2018).

Proposed Changes

Currently, all the API serializers within an app (e.g. dcim) reside in the same file at {app}/api/serializers.py. This causes issues with circular dependencies, where two primary serializers in different apps cross-reference nested serializers: Only one can be imported into the other. This requires duplicating nested serializers in some cases.

Justification

Moving all of the nested serializers into separate files from the primary serializers should avoid duplication, as they can all then be imported freely.

Note: This does not affect the API itself, merely how the code is organized.

Originally created by @jeremystretch on GitHub (Nov 9, 2018). ### Proposed Changes Currently, all the API serializers within an app (e.g. `dcim`) reside in the same file at `{app}/api/serializers.py`. This causes issues with circular dependencies, where two primary serializers in different apps cross-reference nested serializers: Only one can be imported into the other. This requires duplicating nested serializers in some cases. ### Justification Moving all of the nested serializers into separate files from the primary serializers should avoid duplication, as they can all then be imported freely. **Note:** This does not affect the API itself, merely how the code is organized.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 17:22:25 +01:00
adam closed this issue 2025-12-29 17:22:25 +01:00
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: accepted 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#2115
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?