starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-12 13:30:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Inconsistent GUI to API path for VM disks #9115

New Issue
Closed
opened 2025-12-29 20:45:40 +01:00 by adam · 3 comments
adam commented 2025-12-29 20:45:40 +01:00
Owner
Copy Link

Originally created by @stavr666 on GitHub (Jan 19, 2024).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.7.1

Feature type

Change to existing functionality

Proposed functionality

By now, any GUI path that look like:

http(s)://netbox/something/?filters

Can be easy switched to API dataset by adding /api:

http(s)://netbox/api/something/?filters

With VM disk model, for some reason it's looks like:

http(s)://netbox/virtualization/disks/?filters

in GUI. But api path looks like:

http(s)://netbox/api/virtualization/virtual-disks/?filters

Use same pattern, please. Fix GUI path, I suppose, it will not break API solutions.

Use case

Switching back and forth between GUI and API data representation.

Database changes

No response

External dependencies

No response

Originally created by @stavr666 on GitHub (Jan 19, 2024). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.7.1 ### Feature type Change to existing functionality ### Proposed functionality By now, any GUI path that look like: > http(s)://netbox/something/?filters Can be easy switched to API dataset by adding /api: > http(s)://netbox/api/something/?filters With VM disk model, for some reason it's looks like: > http(s)://netbox/virtualization/disks/?filters in GUI. But api path looks like: > http(s)://netbox/api/virtualization/virtual-disks/?filters Use same pattern, please. Fix GUI path, I suppose, it will not break API solutions. ### Use case Switching back and forth between GUI and API data representation. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featurecomplexity: low labels 2025-12-29 20:45:40 +01:00
adam closed this issue 2025-12-29 20:45:40 +01:00
adam commented 2025-12-29 20:45:41 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Jan 19, 2024):

This is a breaking change and will have to wait until the next minor/major release.

@abhi1693 commented on GitHub (Jan 19, 2024): This is a breaking change and will have to wait until the next minor/major release.
adam commented 2025-12-29 20:45:41 +01:00
Author
Owner
Copy Link

@jeffgdotorg commented on GitHub (Apr 3, 2024):

Thanks for catching this inconsistency.

I'm flagging it for engineering review to determine whether we want to tackle it during the v4.0 beta period, or defer it to v4.1 main development.

@jeffgdotorg commented on GitHub (Apr 3, 2024): Thanks for catching this inconsistency. I'm flagging it for engineering review to determine whether we want to tackle it during the v4.0 beta period, or defer it to v4.1 main development.
adam commented 2025-12-29 20:45:41 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 4, 2024):

To be clear, keeping URL paths consistent between the UI and REST API is not a design goal; it generally happens out of coincidence as both are structured very similarly. There are however plenty of examples where they diverge, and this is perfectly fine.

Maybe #15156 would obviate the perceived need for them to match?

@jeremystretch commented on GitHub (Apr 4, 2024): To be clear, keeping URL paths consistent between the UI and REST API is _not_ a design goal; it generally happens out of coincidence as both are structured very similarly. There are however plenty of examples where they diverge, and this is perfectly fine. Maybe #15156 would obviate the perceived need for them to match?
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 complexity: low status: accepted type: feature
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#9115
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?