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

Duplicate all GraphQL component objects into V1 and V2 namespaces #11776

New Issue
Closed
opened 2025-12-29 21:49:44 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:49:44 +01:00
Owner
Copy Link

Originally created by @bctiemann on GitHub (Oct 24, 2025).

Originally assigned to: @bctiemann on GitHub.

Proposed Changes

Duplicate all GraphQL hierarchy objects (Schema -> Query -> Type -> Filter) to separately named V1 versions.

Justification

Because strawberry requires all objects in the GraphQL hierarchy (Schema -> Query -> Type -> Filter) to be uniquely defined, and complicated by the fact that most of the fields in Type classes are defined using strawberry.lazy which looks in specific files for resolving objects, separating V1 and V2 objects by shortcuts such as subclassing or conditional imports is not feasible. The only reasonable way to keep the V1 and V2 schemas separate within the strawberry object space is to duplicate the entire hierarchy and differentiate them with V1 suffixes, defined in duplicate files with _v1.py.

This will add extra work if GraphQL changes that need to apply to both V1 and V2 arise, but it will incentivize us to deprecate V1.

The upside of this is that when V1 is deprecated, cleaning it up will be almost entirely a matter of deleting the _v1.py files.

Originally created by @bctiemann on GitHub (Oct 24, 2025). Originally assigned to: @bctiemann on GitHub. ### Proposed Changes Duplicate all GraphQL hierarchy objects (Schema -> Query -> Type -> Filter) to separately named `V1` versions. ### Justification Because strawberry requires all objects in the GraphQL hierarchy (Schema -> Query -> Type -> Filter) to be uniquely defined, and complicated by the fact that most of the fields in Type classes are defined using `strawberry.lazy` which looks in specific files for resolving objects, separating V1 and V2 objects by shortcuts such as subclassing or conditional imports is not feasible. The only reasonable way to keep the V1 and V2 schemas separate within the strawberry object space is to duplicate the entire hierarchy and differentiate them with `V1` suffixes, defined in duplicate files with `_v1.py`. This will add extra work if GraphQL changes that need to apply to both V1 and V2 arise, but it will incentivize us to deprecate V1. The upside of this is that when V1 is deprecated, cleaning it up will be almost entirely a matter of deleting the `_v1.py` files.
adam added the status: acceptedtype: housekeepingnetbox labels 2025-12-29 21:49:45 +01:00
adam closed this issue 2025-12-29 21:49:45 +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 netbox 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#11776
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?