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

GraphQL support for reverse generic relationships #5111

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

Originally created by @ryanmerolle on GitHub (Jul 28, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0-beta1

Feature type

Change to existing functionality

Proposed functionality

It looks like ForeignKey relationship are automatically handled in the NetBox implementation of graphql, but any relationship via a GenericForeignKey is not created.

From browsing the code I think the following use GenericForeignKey relationships:

  • Cable - termination_a & termination_b - Available via the cable ForeignKey on termination models
  • CablePath - origin & destination - We don't currently support cable paths in the GraphQL API, nor do we link to paths directly in the REST API. Probably needs more discussion.
  • CableTermination - _cable_peer - This is accessible as a forward relation from opposite ends of the cable
  • ObjectChange - changed_object & related_object
  • IPAddress - assigned_object
  • ImageAttachment - parent
  • JournalEntry - assigned_object
  • VLANGroup - scope

Use case

This would be needed if we truly want to leverage graphql queries to tie separated but related models together. For example, we cannot currently tie circuit information or ipam data to a device's interfaces.

Database changes

None

External dependencies

None

Originally created by @ryanmerolle on GitHub (Jul 28, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0-beta1 ### Feature type Change to existing functionality ### Proposed functionality It looks like `ForeignKey` relationship are automatically handled in the NetBox implementation of graphql, but any relationship via a `GenericForeignKey` is not created. From browsing the code I think the following use `GenericForeignKey` relationships: - [x] ~Cable - termination_a & termination_b~ - Available via the `cable` ForeignKey on termination models - [ ] ~CablePath - origin & destination~ - We don't currently support cable paths in the GraphQL API, nor do we link to paths directly in the REST API. Probably needs more discussion. - [x] ~CableTermination - _cable_peer~ - This is accessible as a forward relation from opposite ends of the cable - [x] ObjectChange - changed_object & related_object - [x] IPAddress - assigned_object - [x] ImageAttachment - parent - [x] JournalEntry - assigned_object - [x] VLANGroup - scope ### Use case This would be needed if we truly want to leverage graphql queries to tie separated but related models together. For example, we cannot currently tie circuit information or ipam data to a device's interfaces. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: featurebeta labels 2025-12-29 19:24:23 +01:00
adam closed this issue 2025-12-29 19:24:23 +01:00
adam commented 2025-12-29 19:24:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 29, 2021):

This is a great opportunity for some GraphQL power users to get involved with its development in NetBox.

@jeremystretch commented on GitHub (Jul 29, 2021): This is a great opportunity for some GraphQL power users to get involved with its development in NetBox.
adam commented 2025-12-29 19:24:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 3, 2021):

I've addressed everything but the cable path item in #6873. (That one probably deserves a deeper discussion as it relates to parity with the REST API.)

@jeremystretch commented on GitHub (Aug 3, 2021): I've addressed everything but the cable path item in #6873. (That one probably deserves a deeper discussion as it relates to parity with the REST API.)
adam commented 2025-12-29 19:24:24 +01:00
Author
Owner
Copy Link

@ryanmerolle commented on GitHub (Aug 4, 2021):

Thanks. I will test and revert if anything.

@ryanmerolle commented on GitHub (Aug 4, 2021): Thanks. I will test and revert if anything.
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 beta status: accepted type: feature
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#5111
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?