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

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

New Issue
Closed
opened 2025-12-29 21:25:54 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:25:54 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jul 30, 2024).

Originally assigned to: @jeremystretch on GitHub.

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.

Originally created by @jeremystretch on GitHub (Jul 30, 2024). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Deprecate support for the singular `model` attribute on `PluginTemplateExtension`. Subclasses will need to update accordingly: #### Old ```python class MyExtension(PluginTemplateExtension): model = 'dcim.site' ``` #### New ```python 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.
adam added the status: acceptedtype: deprecation labels 2025-12-29 21:25:54 +01:00
adam closed this issue 2025-12-29 21:25:54 +01:00
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 status: accepted type: deprecation
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#10025
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?