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

Rename certain filters to be consistent #15410

Closed
jeremystretch opened this issue Mar 12, 2024 · 0 comments · Fixed by #16410
Closed

Rename certain filters to be consistent #15410

jeremystretch opened this issue Mar 12, 2024 · 0 comments · Fixed by #16410
Assignees
Labels
breaking change This change modifies or removes some previously documented functionality status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Milestone

Comments

@jeremystretch
Copy link
Member

Proposed Changes

As of v4.0, both names for the filters listed below are supported. In v4.1, support for the old names will be dropped.

Model Old filter New filter
Component templates devicetype_id device_type_id
Component templates moduletype_id module_type_id
extras.ConfigContext role device_role
extras.ConfigContext role_id device_role_id
ipam.Service ipaddress ip_address
ipam.Service ipaddress_id ip_address_id
ipam.VLANGroup sitegroup site_group
ipam.VLANGroup clustergroup cluster_group
vpn.IKEPolicy proposal ike_proposal
vpn.IKEPolicy proposal_id ike_proposal_id
vpn.IPSecPolicy proposal ipsec_proposal
vpn.IPSecPolicy proposal_id ipsec_proposal_id

Justification

Renaming these filters makes them consistent with how other filters in NetBox are named, which enables automated testing and helps avoid user confusion.

Impact

Both names for each filter listed above work in NetBox v4.0. Any API consumers which utilize the listed filters will need to be updated to use the new name for NetBox v4.1.

@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior labels Mar 12, 2024
@jeremystretch jeremystretch added this to the v4.1 milestone Mar 12, 2024
@jeremystretch jeremystretch added the breaking change This change modifies or removes some previously documented functionality label May 31, 2024
@arthanson arthanson self-assigned this Jun 4, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking change This change modifies or removes some previously documented functionality status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants