Closes #21477: Add GraphQL Cable Termination filters for Device, Rack, Location, and Site #293

New Issue

MrUnknownDE · 2026-04-05T16:24:57+02:00

MrUnknownDE commented

2026-04-05 16:24:57 +02:00

Originally created by @pheus on 2/20/2026

Fixes: #21477

This PR adds GraphQL filters for cables based on their terminations’ cached relations (Device, Rack, Location, and Site), bringing GraphQL filtering functionality to parity with the REST API and enabling more effective cable queries by termination attributes.

Example (NetBox demo data)

Filter cables by termination device ID 27 (with deduplication enabled):

query MyQuery {
  cable_list(
    filters: {terminations: {device: {id: {exact: "27"}}, DISTINCT: true}}
  ) {
    id
    display
  }
}

Changes

Expose cached termination relations (device, rack, location, site) for GraphQL filtering via terminations.
Support efficient lookups by leveraging cached relations on CableTermination.

Testing

Added a test in dcim/tests/test_api.py covering filtering by termination device/rack/location/site (including the case where both ends match and DISTINCT prevents duplicates).

*Originally created by @pheus on 2/20/2026* ### Fixes: #21477 This PR adds GraphQL filters for cables based on their terminations’ cached relations (Device, Rack, Location, and Site), bringing GraphQL filtering functionality to parity with the REST API and enabling more effective cable queries by termination attributes. #### Example (NetBox demo data) Filter cables by termination device ID `27` (with deduplication enabled): ```graphql query MyQuery { cable_list( filters: {terminations: {device: {id: {exact: "27"}}, DISTINCT: true}} ) { id display } } ``` #### Changes - Expose cached termination relations (`device`, `rack`, `location`, `site`) for GraphQL filtering via `terminations`. - Support efficient lookups by leveraging cached relations on `CableTermination`. #### Testing - Added a test in `dcim/tests/test_api.py` covering filtering by termination device/rack/location/site (including the case where both ends match and `DISTINCT` prevents duplicates).

MrUnknownDE closed this issue

2026-04-05 16:24:58 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#293