GraphQL DjangoModelType only has pk attribute #10337

New Issue

adam · 2025-12-29T21:30:12+01:00

adam commented

2025-12-29 21:30:12 +01:00

Originally created by @SRF-oberlicy on GitHub (Oct 9, 2024).

Originally assigned to: @arthanson on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.1.1

Python Version

3.11

Steps to Reproduce

When querying cables and their terminations, i cannot get the device name of the terminating interface anymore (since NB v4 / strawberry GraphQL)

Example query:

query {
  virtual_chassis_list {
    name
    members {
      name
      uplink_interfaces: interfaces {
        name
        cable {
          terminations {
            display
            _device {
              pk
            }
          }
        }
      }
    }
  }
}

Expected Behavior

In Netbox 3.7 we were able to query for the parent device of the termination, therefore I would expect have the same or a similar behaviour. Since the pk is available, the name shouldn't be too far away.

Observed Behavior

The DjangoModelType (in this case the _device) only has a pk attribute which provides the ID of the device.

Originally created by @SRF-oberlicy on GitHub (Oct 9, 2024). Originally assigned to: @arthanson on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.1.1 ### Python Version 3.11 ### Steps to Reproduce When querying cables and their terminations, i cannot get the device name of the terminating interface anymore (since NB v4 / strawberry GraphQL) ### Example query: ```graphql query { virtual_chassis_list { name members { name uplink_interfaces: interfaces { name cable { terminations { display _device { pk } } } } } } } ``` ### Expected Behavior In Netbox 3.7 we were able to query for the parent device of the termination, therefore I would expect have the same or a similar behaviour. Since the pk is available, the name shouldn't be too far away. ### Observed Behavior The DjangoModelType (in this case the _device) only has a pk attribute which provides the ID of the device.

adam added the type: bug status: accepted topic: GraphQL severity: low labels 2025-12-29 21:30:12 +01:00

adam closed this issue

2025-12-29 21:30:12 +01:00

adam commented

2025-12-29 21:30:13 +01:00

@arthanson commented on GitHub (Oct 16, 2024):

@SRF-oberlicy Actually the _device, _site, _rack, _locaton fields are internal cached fields and shouldn't actually be exposed, so I will remove those. The correct way would be to query using fragments, something like:

query {
  virtual_chassis_list {
    name
    members {
      name
      uplink_interfaces: interfaces {
        name
        cable {
          terminations {
            display
            termination {
              ... on CircuitTerminationType {
                id
              }              
              ... on ConsolePortType {
                id
                name
              }
              ... on ConsoleServerPortType {
                id
                name
              }

            }
          }
        }
      }
    }
  }
}

@arthanson commented on GitHub (Oct 16, 2024): @SRF-oberlicy Actually the _device, _site, _rack, _locaton fields are internal cached fields and shouldn't actually be exposed, so I will remove those. The correct way would be to query using fragments, something like: ``` query { virtual_chassis_list { name members { name uplink_interfaces: interfaces { name cable { terminations { display termination { ... on CircuitTerminationType { id } ... on ConsolePortType { id name } ... on ConsoleServerPortType { id name } } } } } } } } ```

adam commented

2025-12-29 21:30:13 +01:00

@SRF-oberlicy commented on GitHub (Oct 16, 2024):

@arthanson thanks, we were able to achieve it with the following query:

query {
  virtual_chassis_list {
    name
    members {
      name
      uplink_interfaces: interfaces {
        name
        cable {
          terminations {
            display
            termination {
              ... on InterfaceType {
                name
                device {
                  name
                }
              }
            }
          }
        }
      }
    }
  }
}

@SRF-oberlicy commented on GitHub (Oct 16, 2024): @arthanson thanks, we were able to achieve it with the following query: ```graphql query { virtual_chassis_list { name members { name uplink_interfaces: interfaces { name cable { terminations { display termination { ... on InterfaceType { name device { name } } } } } } } } } ```

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#10337