Add abstract tree model to plugins API #1440

New Issue

MrUnknownDE · 2026-04-06T01:35:05+02:00

MrUnknownDE commented

2026-04-06 01:35:05 +02:00

Originally created by @alehaa on 8/17/2025

NetBox version

v4.3.6

Feature type

Other

Proposed functionality

I suggest adding a new abstract model to the plugins API for implementing tree structures. For implementation, I propose copying NestedGroupModel to NetBoxTreeModel including the parent field only. All other fields remain in NestedGroupModel, now being a child of NetBoxTreeModel.

I’m aware of #12552, but I believe we can still agree on a new implementation will includes a parent field and implement some kind of tree structure. Additionally, plugins should follow the same approach as NetBox during transitioning. However, it would be beneficial to include a note in the documentation that links to #12552.

Use case

Nesting models is a fundamental feature of NetBox, so plugins shouldn’t reinvent the wheel when implementing similar structures. Examples of use cases include or are:

Database changes

None

External dependencies

None

*Originally created by @alehaa on 8/17/2025* ### NetBox version v4.3.6 ### Feature type Other ### Proposed functionality I suggest adding a new abstract model to the plugins API for implementing tree structures. For implementation, I propose copying `NestedGroupModel` to `NetBoxTreeModel` including the `parent` field only. All other fields remain in `NestedGroupModel`, now being a child of `NetBoxTreeModel`. I’m aware of #12552, but I believe we can still agree on a new implementation will includes a `parent` field and implement some kind of tree structure. Additionally, plugins should follow the same approach as NetBox during transitioning. However, it would be beneficial to include a note in the documentation that links to #12552. ### Use case Nesting models is a fundamental feature of NetBox, so plugins shouldn’t reinvent the wheel when implementing similar structures. Examples of use cases include or are: * https://github.com/ArnesSI/netbox-inventory/blob/6fd0652/netbox_inventory/models/assets.py#L20 * https://github.com/Alef-Burzmali/netbox-data-flows/blob/bc8af7d/netbox_data_flows/models/groups.py#L30 * https://github.com/netbox-community/netbox-acls/issues/268 ### Database changes None ### External dependencies None

MrUnknownDE closed this issue

2026-04-06 01:35:05 +02:00

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 type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#1440