Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent GUI to API path for VM disks #14861

Closed
stavr666 opened this issue Jan 19, 2024 · 3 comments
Closed

Inconsistent GUI to API path for VM disks #14861

stavr666 opened this issue Jan 19, 2024 · 3 comments
Assignees
Labels
complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@stavr666
Copy link

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

@stavr666 stavr666 added the type: feature Introduction of new functionality to the application label Jan 19, 2024
@abhi1693
Copy link
Member

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

@jeremystretch jeremystretch added the status: needs triage This issue is awaiting triage by a maintainer label Mar 26, 2024
@jeffgdotorg jeffgdotorg added status: under review Further discussion is needed to determine this issue's scope and/or implementation and removed status: needs triage This issue is awaiting triage by a maintainer labels Apr 3, 2024
@jeffgdotorg
Copy link
Contributor

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.

@jeremystretch
Copy link
Member

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 jeremystretch added complexity: low Requires minimal effort to implement status: backlog Awaiting selection for work and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels May 22, 2024
@jeffgdotorg jeffgdotorg added this to the v4.1 milestone May 31, 2024
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: backlog Awaiting selection for work labels Jul 24, 2024
@jeremystretch jeremystretch self-assigned this Jul 24, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

4 participants