Fixes #21357: Add API for registering custom model actions #246

New Issue

MrUnknownDE · 2026-04-05T16:23:31+02:00

MrUnknownDE commented

2026-04-05 16:23:31 +02:00

Originally created by @jnovinger on 3/3/2026

Fixes: #21357

Adds register_model_actions() API allowing plugins and core to register custom permission actions that appear as checkboxes in ObjectPermissionForm.

Changes:

Add model_actions registry store
Add ModelAction dataclass and register_model_actions() function in utilities.permissions
Add ObjectTypeSplitMultiSelectWidget with data attributes for JS targeting
Add RegisteredActionsWidget for rendering grouped action checkboxes
Update ObjectPermissionForm with consolidated Actions fieldset
Add JavaScript to show/hide actions based on selected object types
Register core actions: DataSource.sync, Device.render_config, VirtualMachine.render_config
Add unit tests for ModelAction and register_model_actions

Plugin usage:

# In plugin's apps.py ready() method
from utilities.permissions import ModelAction, register_model_actions
from .models import MyModel

register_model_actions(MyModel, [
    ModelAction('custom_action', help_text='Description of the action'),
])

Testing instructions:

Navigate to Admin > Permissions > Object Permissions > Add
In the "Object types" field, select models that have registered actions:
- Data Source (Core)
- Device (DCIM)
- Virtual Machine (Virtualization)
Observe the "Custom actions" section appears with checkboxes grouped by model
Remove all models with registered actions - the "Custom actions" field should hide completely
Select a mix of models with and without registered actions - only applicable action groups should show

*Originally created by @jnovinger on 3/3/2026* ### Fixes: #21357 Adds `register_model_actions()` API allowing plugins and core to register custom permission actions that appear as checkboxes in ObjectPermissionForm. **Changes:** - Add `model_actions` registry store - Add `ModelAction` dataclass and `register_model_actions()` function in `utilities.permissions` - Add `ObjectTypeSplitMultiSelectWidget` with data attributes for JS targeting - Add `RegisteredActionsWidget` for rendering grouped action checkboxes - Update `ObjectPermissionForm` with consolidated Actions fieldset - Add JavaScript to show/hide actions based on selected object types - Register core actions: `DataSource.sync`, `Device.render_config`, `VirtualMachine.render_config` - Add unit tests for `ModelAction` and `register_model_actions` **Plugin usage:** ```python # In plugin's apps.py ready() method from utilities.permissions import ModelAction, register_model_actions from .models import MyModel register_model_actions(MyModel, [ ModelAction('custom_action', help_text='Description of the action'), ]) ``` <img width="836" height="786" alt="image" src="https://github.com/user-attachments/assets/cb24b4c8-ecfb-420f-bf8b-c3fa5fd1895c" /> **Testing instructions:** 1. Navigate to Admin > Permissions > Object Permissions > Add 2. In the "Object types" field, select models that have registered actions: - Data Source (Core) - Device (DCIM) - Virtual Machine (Virtualization) 3. Observe the "Custom actions" section appears with checkboxes grouped by model 4. Remove all models with registered actions - the "Custom actions" field should hide completely 5. Select a mix of models with and without registered actions - only applicable action groups should show

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#246