Search integration in plugins #6238

Closed
opened 2025-12-29 19:38:24 +01:00 by adam · 4 comments
Owner

Originally created by @johannwagner on GitHub (Mar 21, 2022).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.1.6

Feature type

New functionality

Proposed functionality

We would like to introduce a possibility to search within added models of plugins. We would probably add a search.py within the plugin root repository that exposes a similar formed structure as in 6c686af1b7/netbox/netbox/search.py (L241), similar to menu items. Therefore, this can be included into SEARCH_TYPES on plugin load to to enable a search in plugins.

We would be happy to provide a PR.

Use case

We do some heavy lifting within Netbox plugins that is going to be extended after the next v3.2 release. Therefore, we need to search in our custom models to ensure a good usability.

Database changes

None

External dependencies

None

Originally created by @johannwagner on GitHub (Mar 21, 2022). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.1.6 ### Feature type New functionality ### Proposed functionality We would like to introduce a possibility to search within added models of plugins. We would probably add a `search.py` within the plugin root repository that exposes a similar formed structure as in https://github.com/netbox-community/netbox/blob/6c686af1b70acdc56a8fdbe84451f7012e2b4197/netbox/netbox/search.py#L241, similar to menu items. Therefore, this can be included into `SEARCH_TYPES` on plugin load to to enable a search in plugins. We would be happy to provide a PR. ### Use case We do some heavy lifting within Netbox plugins that is going to be extended after the next v3.2 release. Therefore, we need to search in our custom models to ensure a good usability. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: featuretopic: plugins labels 2025-12-29 19:38:24 +01:00
adam closed this issue 2025-12-29 19:38:24 +01:00
Author
Owner

@ryanmerolle commented on GitHub (Aug 25, 2022):

@jeremystretch If @johannwagner details out his approach, would you be happy to assign him this issue?

@ryanmerolle commented on GitHub (Aug 25, 2022): @jeremystretch If @johannwagner details out his approach, would you be happy to assign him this issue?
Author
Owner

@jeremystretch commented on GitHub (Aug 25, 2022):

This is blocked until we come up with a new global search implementation (currently tracked under #7016).

@jeremystretch commented on GitHub (Aug 25, 2022): This is blocked until we come up with a new global search implementation (currently tracked under #7016).
Author
Owner

@jeremystretch commented on GitHub (Sep 27, 2022):

We're flipping this around a bit. The plan now is to introduce a dynamic registration for model search first, and then to implement an improved search engine under #7016.

@jeremystretch commented on GitHub (Sep 27, 2022): We're flipping this around a bit. The plan now is to introduce a dynamic registration for model search first, and then to implement an improved search engine under #7016.
Author
Owner

@arthanson commented on GitHub (Oct 12, 2022):

was already fixed and merged into feature https://github.com/netbox-community/netbox/pull/10489 so closing.

@arthanson commented on GitHub (Oct 12, 2022): was already fixed and merged into feature https://github.com/netbox-community/netbox/pull/10489 so closing.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6238