Skip to content

Conversation

@cernymi
Copy link
Contributor

@cernymi cernymi commented Nov 21, 2025

Related Issue

None

New Behavior

None

...

Contrast to Current Behavior

None

...

Discussion: Benefits and Drawbacks

The current variable names version and full_version can be ambiguous, as it’s not immediately clear whether they refer to the API version, the NetBox application version, or something else.

This change renames them to:

  • api_version → clearly indicates the version of the NetBox API being used.
  • netbox_version → explicitly refers to the full NetBox application version.

Benefits:

  • Improves code clarity and readability.
  • Reduces potential confusion when working with both API and application versions.
  • Aligns terminology with NetBox documentation and common conventions.

...

Changes to the Documentation

None

...

Proposed Release Note Entry

  • rename variable version to api_version.
  • rename variable full_version to netbox_version.

...

Double Check

  • I have read the comments and followed the CONTRIBUTING.md.
  • I have explained my PR according to the information in the comments or in a linked issue.
  • My PR targets the devel branch.

@sc68cal
Copy link
Contributor

sc68cal commented Nov 24, 2025

This is a good idea. I just need to get some cycles to review and merge, thanks you for the contribution

@sc68cal sc68cal merged commit db5086d into netbox-community:devel Nov 25, 2025
57 checks passed
@cernymi cernymi deleted the cernymi/api_verson branch November 25, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants