NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Document support for ObjectChildrenView

Browse Source
This commit is contained in:
jeremystretch 2022-06-29 14:30:47 -04:00
parent 4649bc632c
commit a0f9b5e47b
2 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -51,15 +51,16 @@ This makes our view accessible at the URL `/plugins/animal-sounds/random/`. (Rem
NetBox provides several generic view classes (documented below) to facilitate common operations, such as creating, viewing, modifying, and deleting objects. Plugins can subclass these views for their own use. NetBox provides several generic view classes (documented below) to facilitate common operations, such as creating, viewing, modifying, and deleting objects. Plugins can subclass these views for their own use.
| View Class | Description | | View Class | Description |
|--------------------|--------------------------------| |----------------------|--------------------------------------------------------|
| `ObjectView` | View a single object | | `ObjectView` | View a single object |
| `ObjectEditView` | Create or edit a single object | | `ObjectEditView` | Create or edit a single object |
| `ObjectDeleteView` | Delete a single object | | `ObjectDeleteView` | Delete a single object |
| `ObjectListView` | View a list of objects | | `ObjectChildrenView` | A list of child objects within the context of a parent |
| `BulkImportView` | Import a set of new objects | | `ObjectListView` | View a list of objects |
| `BulkEditView` | Edit multiple objects | | `BulkImportView` | Import a set of new objects |
| `BulkDeleteView` | Delete multiple objects | | `BulkEditView` | Edit multiple objects |
| `BulkDeleteView` | Delete multiple objects |
!!! warning !!! warning
Please note that only the classes which appear in this documentation are currently supported. Although other classes may be present within the `views.generic` module, they are not yet supported for use by plugins. Please note that only the classes which appear in this documentation are currently supported. Although other classes may be present within the `views.generic` module, they are not yet supported for use by plugins.
@ -99,6 +100,12 @@ Below are the class definitions for NetBox's object views. These views handle CR
members: members:
- get_object - get_object
::: netbox.views.generic.ObjectChildrenView
selection:
members:
- get_children
- prep_table_data
## Multi-Object Views ## Multi-Object Views
Below are the class definitions for NetBox's multi-object views. These views handle simultaneous actions for sets objects. The list, import, edit, and delete views each inherit from `BaseMultiObjectView`, which is not intended to be used directly. Below are the class definitions for NetBox's multi-object views. These views handle simultaneous actions for sets objects. The list, import, edit, and delete views each inherit from `BaseMultiObjectView`, which is not intended to be used directly.

1
docs/release-notes/version-3.3.md
View File

@ -34,6 +34,7 @@
### Plugins API ### Plugins API
* [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view
* [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes
### Other Changes ### Other Changes