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

Adjust netbox-version in /api/status to show version only #10767

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

Originally created by @rodvand on GitHub (Feb 12, 2025).

Originally assigned to: @rodvand on GitHub.

NetBox version

v4.2.3

Feature type

Change to existing functionality

Proposed functionality

Currently the /api/status endpoint shows a dictionary with the netbox-version key showing the "full" version. The full version is defined in

f8022040b2/netbox/utilities/release.py (L37-L41)

and includes specific build if needed. This is an issue when some application (in this case the NetBox ansible collection) expects the NetBox version to be the version without build info.

I think we could either move the netbox-version to a netbox-full-version key, or change the netbox-version to use the netbox.settings.RELEASE.version as the output.

Use case

Allow applications to use the netbox-version key for comparing without too much extra parsing.

This issue has popped up as the netbox-docker project has added build info in the local/release.yaml, and the netbox.settings.RELEASE.version now looks like '4.2.3-Docker-3.2.0'.

Database changes

No response

External dependencies

No response

Originally created by @rodvand on GitHub (Feb 12, 2025). Originally assigned to: @rodvand on GitHub. ### NetBox version v4.2.3 ### Feature type Change to existing functionality ### Proposed functionality Currently the `/api/status` endpoint shows a dictionary with the netbox-version key showing the "full" version. The full version is defined in https://github.com/netbox-community/netbox/blob/f8022040b245790796a82b38a67570335a320b74/netbox/utilities/release.py#L37-L41 and includes specific build if needed. This is an issue when some application (in this case the NetBox ansible collection) expects the NetBox version to be the version without build info. I think we could either move the netbox-version to a netbox-full-version key, or change the netbox-version to use the `netbox.settings.RELEASE.version` as the output. ### Use case Allow applications to use the netbox-version key for comparing without too much extra parsing. This issue has popped up as the netbox-docker project has added build info in the local/release.yaml, and the `netbox.settings.RELEASE.version` now looks like '4.2.3-Docker-3.2.0'. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featurebreaking changecomplexity: low labels 2025-12-29 21:35:43 +01:00
adam closed this issue 2025-12-29 21:35:44 +01:00
adam commented 2025-12-29 21:35:44 +01:00
Author
Owner
Copy Link

@bctiemann commented on GitHub (Feb 24, 2025):

This seems like a worthwhile change and a valid use case, but as this is a breaking change to the API it needs to be targeted to a minor release milestone and the feature branch.

@bctiemann commented on GitHub (Feb 24, 2025): This seems like a worthwhile change and a valid use case, but as this is a breaking change to the API it needs to be targeted to a minor release milestone and the `feature` branch.
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 breaking change 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#10767
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?