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

API-Version header could be more precise #8188

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

Originally created by @CADbloke on GitHub (Jun 13, 2023).

NetBox version

3.5.3

Feature type

Change to existing functionality

Proposed functionality

API header API-Version for API calls to https://demo.netbox.dev/api/ is 3.5 but https://demo.netbox.dev/api/status/ says "netbox-version": "3.5.3". There are differences between versions 3.5.1 & 3.5.3, for example, so the version header could be more precise.

In some cases the difference is significant. When integer maximums change, sat from 2147483647 to 32767 it changes the expected type in many strongly-typed languages. This example is from PowerPortRequest.allocated_draw

Use case

Object validation which differs between API versions

Database changes

none.

External dependencies

none.

Originally created by @CADbloke on GitHub (Jun 13, 2023). ### NetBox version 3.5.3 ### Feature type Change to existing functionality ### Proposed functionality API header `API-Version` for API calls to https://demo.netbox.dev/api/ is 3.5 but https://demo.netbox.dev/api/status/ says "netbox-version": "3.5.3". There are differences between versions 3.5.1 & 3.5.3, for example, so the version header could be more precise. In some cases the difference is significant. When integer maximums change, sat from 2147483647 to 32767 it changes the expected type in many strongly-typed languages. This example is from `PowerPortRequest.allocated_draw` ### Use case Object validation which differs between API versions ### Database changes none. ### External dependencies none.
adam added the type: feature label 2025-12-29 20:33:36 +01:00
adam closed this issue 2025-12-29 20:33:36 +01:00
adam commented 2025-12-29 20:33:36 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 13, 2023):

The status endpoint reports the specific NetBox version; the API itself is versioned only to the minor release, as it is not intended to change between e.g. 3.4 and 3.5.

In some cases the difference is significant. When integer maximums change, sat from 2147483647 to 32767 it changes the expected type in many strongly-typed languages. This example is from PowerPortRequest.allocated_draw

You could make a case that such changes should be deferred to the next minor release, however that did not seem to be a concern regarding this particular change.

@jeremystretch commented on GitHub (Jun 13, 2023): The status endpoint reports the specific NetBox version; the API itself is versioned only to the minor release, as it is not intended to change between e.g. 3.4 and 3.5. > In some cases the difference is significant. When integer maximums change, sat from 2147483647 to 32767 it changes the expected type in many strongly-typed languages. This example is from PowerPortRequest.allocated_draw You could make a case that such changes should be deferred to the next minor release, however that did not seem to be a concern regarding this particular change.
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 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#8188
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?