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

Hide plugin models from widgets if desired #8162

New Issue
Closed
opened 2025-12-29 20:33:16 +01:00 by adam · 3 comments
adam commented 2025-12-29 20:33:16 +01:00
Owner
Copy Link

Originally created by @dreng on GitHub (Jun 4, 2023).

NetBox version

v3.5.4-dev

Feature type

Change to existing functionality

Proposed functionality

Please implement a parameter for plugin models in order to make them hide from widgets' config. Something like:

class Meta:
    widget = False

Use case

It turned out that a misconfiguration within a widget may render NetBox unusable. See #12520. In this case a user tried to create a widget that contains a model from the NetBox Topology Views Plugin. This model has never been intended to be listed or counted. It has only one special custom view and no list view.

Adding this model will result in an error. As a result, no page can be opened any more. It is not exactly a bug, but it looks like one to the user.

Implementing the proposed parameter let plugin developers prevent this misconfiguration.

Another Solution would be to check if the model supports being counted before it shows up in the widget configuration. I don't know if that would be an easier way.

Database changes

None

External dependencies

None that I am aware of.

Originally created by @dreng on GitHub (Jun 4, 2023). ### NetBox version v3.5.4-dev ### Feature type Change to existing functionality ### Proposed functionality Please implement a parameter for plugin models in order to make them hide from widgets' config. Something like: ``` class Meta: widget = False ``` ### Use case It turned out that a misconfiguration within a widget may render NetBox unusable. See #12520. In this case a user tried to create a widget that contains a model from the NetBox Topology Views Plugin. This model has never been intended to be listed or counted. It has only one special custom view and no list view. Adding this model will result in an error. As a result, no page can be opened any more. It is not exactly a bug, but it looks like one to the user. Implementing the proposed parameter let plugin developers prevent this misconfiguration. Another Solution would be to check if the model supports being counted before it shows up in the widget configuration. I don't know if that would be an easier way. ### Database changes None ### External dependencies None that I am aware of.
adam added the type: featurestatus: under review labels 2025-12-29 20:33:16 +01:00
adam closed this issue 2025-12-29 20:33:16 +01:00
adam commented 2025-12-29 20:33:16 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 14, 2023):

This model has never been intended to be listed or counted. It has only one special custom view and no list view.

This touches on the recurring theme of "public" vs "private" models in NetBox. We don't have a good solution for this currently.

@jeremystretch commented on GitHub (Jun 14, 2023): > This model has never been intended to be listed or counted. It has only one special custom view and no list view. This touches on the recurring theme of "public" vs "private" models in NetBox. We don't have a good solution for this currently.
adam commented 2025-12-29 20:33:17 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Sep 13, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Sep 13, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:33:17 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 6, 2023):

I think this will be captured under #13427, so let's capture any further conversation related to this use case under that issue.

@jeremystretch commented on GitHub (Oct 6, 2023): I think this will be captured under #13427, so let's capture any further conversation related to this use case under that issue.
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: under review type: feature
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#8162
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?