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.

Sign up for GitHub

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

Jump to bottom

Default Nautobot API Version #2799

Closed
12 tasks
itdependsnetworks opened this issue Nov 10, 2022 · 2 comments · Fixed by #3810
Closed
12 tasks

Default Nautobot API Version #2799

itdependsnetworks opened this issue Nov 10, 2022 · 2 comments · Fixed by #3810
Assignees
@glennmatthews
Labels
type: feature Introduction of new or enhanced functionality to the application
Milestone
v2.0.0

Comments

@itdependsnetworks
Copy link
Contributor

itdependsnetworks commented Nov 10, 2022 •
edited by bryanculver
Loading

As ...

Austin - Network Automation Engineer

I want ...

Use the latest features that are offered by the API

So that ...

  • I may get maximum benefit from the latest features.
  • Know when there are small breaking changes vs only when there are major breaking changes

I know this is done when...

Without setting a header, I get the latest API functionality given I am using the latest version of code.

Optional - Feature groups this request pertains to.

  • Automation
  • Circuits
  • DCIM
  • IPAM
  • Misc (including Data Sources)
  • Organization
  • Plugins (and other Extensibility)
  • Security (Secrets, etc)
  • Image Management
  • UI/UX
  • Documentation
  • Other (not directly a platform feature)

Database Changes

N/A

External Dependencies

No response

TODO

  • Verify DRF's default behavior when DEFAULT_VERSION is None, expecting it chooses the latest
  • Remove DEFAULT_VERSION from settings.py
  • Make it easier via config and documentation to override "default to latest" behavior
@itdependsnetworks itdependsnetworks added the type: feature Introduction of new or enhanced functionality to the application label Nov 10, 2022
@bryanculver bryanculver added this to the v2.0.0 milestone Nov 15, 2022
@bryanculver
Copy link
Member

Allowing a "magic" setting of latest as well as a specific version to be provided here: https://github.com/nautobot/nautobot/blob/develop/nautobot/core/settings.py#L195 should suffice. We should by default still fall back to the oldest minor version if not provided.

@bryanculver bryanculver mentioned this issue Feb 9, 2023
Merged
3 tasks
@Kircheneer Kircheneer mentioned this issue Feb 9, 2023
Open
@glennmatthews glennmatthews mentioned this issue Feb 27, 2023
Closed
@glennmatthews glennmatthews self-assigned this May 25, 2023
glennmatthews added a commit that referenced this issue May 25, 2023
@glennmatthews
Fix #2799 - change default REST API versioning behavior to latest.
22bbfe7
@glennmatthews glennmatthews mentioned this issue May 25, 2023
Merged
5 tasks
@glennmatthews glennmatthews linked a pull request May 25, 2023 that will close this issue
Fix #2799 - change default REST API versioning behavior to latest. #3810
Merged
5 tasks
glennmatthews added a commit that referenced this issue May 26, 2023
@glennmatthews
Fix #2799 - change default REST API versioning behavior to latest. (#…
d22d8c0 
…3810)
@glennmatthews
Copy link
Contributor

Implemented for 2.0 by #3810.

@bryanculver bryanculver mentioned this issue Aug 17, 2023
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@glennmatthews glennmatthews

Labels
type: feature Introduction of new or enhanced functionality to the application
Projects
No open projects
Nautobot Core ⚙️
Archived in project
Milestone
v2.0.0
Development

Successfully merging a pull request may close this issue.

Fix #2799 - change default REST API versioning behavior to latest. nautobot/nautobot
3 participants
@bryanculver @glennmatthews @itdependsnetworks