Extend More GraphQL Relationships #7084

Closed
opened 2025-12-29 20:19:01 +01:00 by adam · 0 comments
Owner

Originally created by @arthanson on GitHub (Oct 6, 2022).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.3.3

Feature type

Change to existing functionality

Proposed functionality

Extend GraphQL relationships for more GFK models (for example cable a_terminations, b_terminations).

Each CableTermination maps a particular object to a cable (associating it with either the A or B end). The REST API includes a_terminations and b_terminations for each cable using GenericObjectSerializer.

  • L2VPN terminations work similarly to cable terminations.
  • Device components (e.g. dcim.Interface) and component templates (e.g. dcim.InterfaceTemplate) can have inventory items assigned to them.
  • Most objects in NetBox support change logging, so we probably want a way to return all ObjectChanges associated with a particular object.
  • Same as above with journal entries.
  • Several models (sites, rack, devices...) support the attachment of ImageAttachments and/or ContactAssignments.
  • Both device and VM interfaces can have IP addresses and/or FHRP groups assigned to them.
  • A VLAN group can define its scope as a region, site group, site, location, rack, cluster group, or cluster.

Use case

Allows GraphQL queries to trace through objects like cabling, matching the REST API better.

Database changes

No response

External dependencies

No response

Originally created by @arthanson on GitHub (Oct 6, 2022). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.3.3 ### Feature type Change to existing functionality ### Proposed functionality Extend GraphQL relationships for more GFK models (for example cable a_terminations, b_terminations). Each CableTermination maps a particular object to a cable (associating it with either the A or B end). The REST API includes a_terminations and b_terminations for each cable using GenericObjectSerializer. - L2VPN terminations work similarly to cable terminations. - Device components (e.g. dcim.Interface) and component templates (e.g. dcim.InterfaceTemplate) can have inventory items assigned to them. - Most objects in NetBox support change logging, so we probably want a way to return all ObjectChanges associated with a particular object. - Same as above with journal entries. - Several models (sites, rack, devices...) support the attachment of ImageAttachments and/or ContactAssignments. - Both device and VM interfaces can have IP addresses and/or FHRP groups assigned to them. - A VLAN group can define its scope as a region, site group, site, location, rack, cluster group, or cluster. ### Use case Allows GraphQL queries to trace through objects like cabling, matching the REST API better. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 20:19:01 +01:00
adam closed this issue 2025-12-29 20:19:01 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7084