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

Deprecate support for registering a PluginTemplateExtension subclass via model (singular) #17029

Closed
jeremystretch opened this issue Jul 30, 2024 · 0 comments
Closed

Deprecate support for registering a PluginTemplateExtension subclass via model (singular) #17029

jeremystretch opened this issue Jul 30, 2024 · 0 comments
Assignees
@jeremystretch
Labels
status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Milestone
v4.2

Comments

@jeremystretch
Copy link
Member

Proposed Changes

Deprecate support for the singular model attribute on PluginTemplateExtension. Subclasses will need to update accordingly:

Old

class MyExtension(PluginTemplateExtension):
    model = 'dcim.site'

New

class MyExtension(PluginTemplateExtension):
    models = ['dcim.site']

Justification

NetBox v4.1 introduced support for registering on one or more models via the new models (plural) attribute, which obsoleted the singular form.

Impact

PluginTemplateExtension subclasses which continue to register using the model attribute will generate a deprecation warning.
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior labels Jul 30, 2024
@jeremystretch jeremystretch added this to the v4.2 milestone Jul 30, 2024
@jeremystretch jeremystretch self-assigned this Oct 7, 2024
jeremystretch added a commit that referenced this issue Oct 17, 2024
@jeremystretch
Closes #17029: Deprecate PluginTemplateExtension.model
77a9da2
@jeremystretch jeremystretch mentioned this issue Oct 17, 2024
Merged
jeremystretch added a commit that referenced this issue Oct 18, 2024
@jeremystretch
Closes #17029: Deprecate PluginTemplateExtension.model
6aeb553
@jeremystretch jeremystretch mentioned this issue Nov 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jeremystretch jeremystretch

Labels
status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Projects
None yet
Milestone
v4.2
Development

No branches or pull requests
1 participant
@jeremystretch