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 fails to show ProviderNetworks in Interface connected_endpoints #8958

New Issue
Closed
opened 2025-12-29 20:43:21 +01:00 by adam · 2 comments
adam commented 2025-12-29 20:43:21 +01:00
Owner
Copy Link

Originally created by @bogi788 on GitHub (Dec 13, 2023).

Originally assigned to: @arthanson on GitHub.

Deployment Type

Self-hosted

NetBox Version

v3.6.6

Python Version

3.11

Steps to Reproduce

When performing GraphQL queries on interfaces the connected_endpoints property fails to "expand" when connected to ProviderNetwork objects (via circuits).

Editing dcim/graphql/gfk_mixins.py and adding ProviderNetwork/ProviderNetworkType to LinkPeerType allows the query to succeed.

Expected Behavior

The GraphQL API should include all supported connected_endpoints types or the cable trace (for GraphQL) stop at the CircuitTermination that is already listed in the schema for LinkPeerType.

Observed Behavior

The query

query{
  interface_list(...) {
    id
    connected_endpoints{
      ... on CircuitTerminationType{
        id
      }
    }
  }
}

results in the following error message via the GraphQL API:

Abstract type 'LinkPeerType' must resolve to an Object type at runtime for field 'InterfaceType.connected_endpoints'. Either the 'LinkPeerType' type should provide a 'resolve_type' function or each possible type should provide an 'is_type_of' function.

Originally created by @bogi788 on GitHub (Dec 13, 2023). Originally assigned to: @arthanson on GitHub. ### Deployment Type Self-hosted ### NetBox Version v3.6.6 ### Python Version 3.11 ### Steps to Reproduce When performing GraphQL queries on interfaces the connected_endpoints property fails to "expand" when connected to ProviderNetwork objects (via circuits). Editing dcim/graphql/gfk_mixins.py and adding ProviderNetwork/ProviderNetworkType to LinkPeerType allows the query to succeed. ### Expected Behavior The GraphQL API should include all supported connected_endpoints types or the cable trace (for GraphQL) stop at the CircuitTermination that is already listed in the schema for LinkPeerType. ### Observed Behavior The query ``` query{ interface_list(...) { id connected_endpoints{ ... on CircuitTerminationType{ id } } } } ``` results in the following error message via the GraphQL API: `Abstract type 'LinkPeerType' must resolve to an Object type at runtime for field 'InterfaceType.connected_endpoints'. Either the 'LinkPeerType' type should provide a 'resolve_type' function or each possible type should provide an 'is_type_of' function.`
adam added the type: bugstatus: acceptedtopic: GraphQLseverity: low labels 2025-12-29 20:43:21 +01:00
adam closed this issue 2025-12-29 20:43:21 +01:00
adam commented 2025-12-29 20:43:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 15, 2023):

@Zaptho @pzoppoth @fstolba @anx-mpraxmarer @rwielk @Gaste8 you were all very quick to 👍 this issue. Would any of you like to volunteer to fix it?

@jeremystretch commented on GitHub (Dec 15, 2023): @Zaptho @pzoppoth @fstolba @anx-mpraxmarer @rwielk @Gaste8 you were all very quick to :+1: this issue. Would any of you like to volunteer to fix it?
adam commented 2025-12-29 20:43:22 +01:00
Author
Owner
Copy Link

@bogi788 commented on GitHub (Dec 15, 2023):

https://github.com/bogi788/netbox/tree/14511-graphql-connected-endpoints contains the fix I've been using, but I'm unsure if adding a new type is the correct approach.

@bogi788 commented on GitHub (Dec 15, 2023): https://github.com/bogi788/netbox/tree/14511-graphql-connected-endpoints contains the fix I've been using, but I'm unsure if adding a new type is the correct approach.
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 severity: low status: accepted topic: GraphQL type: bug
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#8958
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?