NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-16 12:12:53 -06:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Jeremy Stretch 2025-07-01 09:37:05 -04:00
parent 2927b8dae1
commit b30a251069
3 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/plugins/development/views.md
View File

@ -64,6 +64,7 @@ Generic view classes (documented below) facilitate common operations, such as cr
| `ObjectListView` | View a list of objects | | `ObjectListView` | View a list of objects |
| `BulkImportView` | Import a set of new objects | | `BulkImportView` | Import a set of new objects |
| `BulkEditView` | Edit multiple objects | | `BulkEditView` | Edit multiple objects |
| `BulkRenameView` | Rename multiple objects |
| `BulkDeleteView` | Delete multiple objects | | `BulkDeleteView` | Delete multiple objects |
!!! warning !!! warning
@ -171,6 +172,10 @@ Below are the class definitions for NetBox's multi-object views. These views han
options: options:
members: false members: false
::: netbox.views.generic.BulkRenameView
options:
members: false
::: netbox.views.generic.BulkDeleteView ::: netbox.views.generic.BulkDeleteView
options: options:
members: members:

6
netbox/netbox/views/generic/bulk_views.py
View File

@ -55,8 +55,7 @@ class ObjectListView(BaseMultiObjectView, ActionsMixin, TableMixin):
Attributes: Attributes:
filterset: A django-filter FilterSet that is applied to the queryset filterset: A django-filter FilterSet that is applied to the queryset
filterset_form: The form class used to render filter options filterset_form: The form class used to render filter options
actions: A mapping of supported actions to their required permissions. When adding custom actions, bulk actions: An iterable of ObjectAction subclasses (see ActionsMixin)
action names must be prefixed with `bulk_`. (See ActionsMixin.)
""" """
template_name = 'generic/object_list.html' template_name = 'generic/object_list.html'
filterset = None filterset = None
@ -731,6 +730,9 @@ class BulkEditView(GetReturnURLMixin, BaseMultiObjectView):
class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView): class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView):
""" """
An extendable view for renaming objects in bulk. An extendable view for renaming objects in bulk.
Attributes:
field_name: The name of the object attribute for which the value is being updated (defaults to "name")
""" """
field_name = 'name' field_name = 'name'
template_name = 'generic/bulk_rename.html' template_name = 'generic/bulk_rename.html'

4
netbox/netbox/views/generic/object_views.py
View File

@ -47,6 +47,7 @@ class ObjectView(ActionsMixin, BaseObjectView):
Attributes: Attributes:
tab: A ViewTab instance for the view tab: A ViewTab instance for the view
actions: An iterable of ObjectAction subclasses (see ActionsMixin)
""" """
tab = None tab = None
actions = (CloneObject, EditObject, DeleteObject) actions = (CloneObject, EditObject, DeleteObject)
@ -96,8 +97,7 @@ class ObjectChildrenView(ObjectView, ActionsMixin, TableMixin):
table: The django-tables2 Table class used to render the child objects list table: The django-tables2 Table class used to render the child objects list
filterset: A django-filter FilterSet that is applied to the queryset filterset: A django-filter FilterSet that is applied to the queryset
filterset_form: The form class used to render filter options filterset_form: The form class used to render filter options
actions: A mapping of supported actions to their required permissions. When adding custom actions, bulk actions: An iterable of ObjectAction subclasses (see ActionsMixin)
action names must be prefixed with `bulk_`. (See ActionsMixin.)
""" """
child_model = None child_model = None
table = None table = None