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

Prefetch DeviceType.subdevice_role for Devices API requests #3570

New Issue
Closed
opened 2025-12-29 18:29:56 +01:00 by adam · 1 comment
adam commented 2025-12-29 18:29:56 +01:00
Owner
Copy Link

Originally created by @netsandbox on GitHub (Apr 14, 2020).

Environment

  • Python version: 3.6.9
  • NetBox version: 2.7.12

Proposed Functionality

Prefetch DeviceType.subdevice_role for Devices API requests (https://netbox/api/dcim/devices/).

Currently DeviceType.manufacturer is already prefetched:
ee51dae73f/netbox/dcim/api/views.py (L319-L322)

Use Case

Sometimes Devices need a special handling whether their DeviceType.subdevice_role is parent, child or None.
In our case, we want to use NetBox as Ansible inventory source, but we will not manage in Ansible Devices which DeviceType.subdevice_role is parent.

Currently we have to get first all Devices from the API, and then use the device_type.url to make another request to the API for each Device to get the subdevice_role.

If device_type.subdevice_role would be accessible in the Devices API request, we only have to do one API request.

Database Changes

None

External Dependencies

None

Originally created by @netsandbox on GitHub (Apr 14, 2020). ### Environment * Python version: 3.6.9 * NetBox version: 2.7.12 ### Proposed Functionality Prefetch `DeviceType.subdevice_role` for Devices API requests (https://netbox/api/dcim/devices/). Currently `DeviceType.manufacturer` is already prefetched: https://github.com/netbox-community/netbox/blob/ee51dae73f1fc0ad306c16f95efcfa9a5474fd81/netbox/dcim/api/views.py#L319-L322 ### Use Case Sometimes Devices need a special handling whether their DeviceType.subdevice_role is parent, child or None. In our case, we want to use NetBox as Ansible inventory source, but we will not manage in Ansible Devices which DeviceType.subdevice_role is parent. Currently we have to get first all Devices from the API, and then use the device_type.url to make another request to the API for each Device to get the subdevice_role. If device_type.subdevice_role would be accessible in the Devices API request, we only have to do one API request. ### Database Changes None ### External Dependencies None
adam closed this issue 2025-12-29 18:29:56 +01:00
adam commented 2025-12-29 18:29:56 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 15, 2020):

Currently we have to get first all Devices from the API, and then use the device_type.url to make another request to the API for each Device to get the subdevice_role.

The same is true for any of the dozen or so other device model properties. Including them all would result in excessively large and slow responses. That's why we use minimal nested serializations of related objects, which contain the minimum amount of information necessary to display a meaningful reference to the object. This is consistent throughout the entire API.

@jeremystretch commented on GitHub (Apr 15, 2020): > Currently we have to get first all Devices from the API, and then use the device_type.url to make another request to the API for each Device to get the subdevice_role. The same is true for any of the dozen or so other device model properties. Including them all would result in excessively large and slow responses. That's why we use minimal nested serializations of related objects, which contain the minimum amount of information necessary to display a meaningful reference to the object. This is consistent throughout the entire API.
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
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#3570
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?