GraphQL: Extend relationships further #6536

New Issue

adam · 2025-12-29T19:42:05+01:00

adam commented

2025-12-29 19:42:05 +01:00

Originally created by @ryanmerolle on GitHub (Jun 3, 2022).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.2.4

Feature type

Change to existing functionality

Proposed functionality

I am not really going to articulate this well, but I have noticed many GraphQL models do not go very deep into the relationships of other models.

Use case

Examples:

{
  circuit_list {
    id
    cid
    type {
      name
    }
    termination_a {
      _link_peer_type {
        id
      }
    termination_b {
      _link_peer_type {
        id
      }
      _link_peer_id
    }
  }
}

termination_a & termination_b do not (at bare minimum) allow you to grab the display or device keys like you can with the REST API. In reality, you should be able to further follow the path of the relationship to include information about the models related.

Possible Use Cases:
Gather circuit, termination, cable, ip address, and connected peer device/interface/ip details
Filtering circuits based on the status of the site it's attached to @tyler-8 example from chat
Filtering circuits based on the VLAN membership of the interface it's connected to @tyler-8 example from chat.

There are a whole host of items like this where the relationship cannot be followed to the end within graphql. To quote @tyler-8 "Yeah graphql would really shine if we unlocked more of that" .."I'm just not sure how that works in graphene, like if it's "easy" to do that or if you basically have to explicitly define all of those things every time"

Database changes

No response

External dependencies

No response

Originally created by @ryanmerolle on GitHub (Jun 3, 2022). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.2.4 ### Feature type Change to existing functionality ### Proposed functionality I am not really going to articulate this well, but I have noticed many GraphQL models do not go very deep into the relationships of other models. ### Use case Examples: ``` { circuit_list { id cid type { name } termination_a { _link_peer_type { id } termination_b { _link_peer_type { id } _link_peer_id } } } ``` termination_a & termination_b do not (at bare minimum) allow you to grab the display or device keys like you can with the REST API. In reality, you should be able to further follow the path of the relationship to include information about the models related. **Possible Use Cases:** Gather circuit, termination, cable, ip address, and connected peer device/interface/ip details Filtering circuits based on the status of the site it's attached to @tyler-8 example from chat Filtering circuits based on the VLAN membership of the interface it's connected to @tyler-8 example from chat. There are a whole host of items like this where the relationship cannot be followed to the end within graphql. To quote @tyler-8 "Yeah graphql would really shine if we unlocked more of that" .."I'm just not sure how that works in graphene, like if it's "easy" to do that or if you basically have to explicitly define all of those things every time" ### Database changes _No response_ ### External dependencies _No response_

adam added the status: accepted type: feature labels 2025-12-29 19:42:05 +01:00

adam closed this issue

2025-12-29 19:42:05 +01:00

adam commented

2025-12-29 19:42:06 +01:00

@basti1508 commented on GitHub (Jun 20, 2022):

Since I am creating Switch-Configs from the Information stored in Netbox, the possibility to have the connected_endpoint on an interface would be a real gamechanger.

@basti1508 commented on GitHub (Jun 20, 2022): Since I am creating Switch-Configs from the Information stored in Netbox, the possibility to have the connected_endpoint on an interface would be a real gamechanger.

adam commented

2025-12-29 19:42:06 +01:00

@jeremystretch commented on GitHub (Jul 27, 2022):

Blocked by #9856

@jeremystretch commented on GitHub (Jul 27, 2022): Blocked by #9856

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#6536