Search integration in plugins

[johannwagner]

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

netbox/netbox/netbox/search.py

Line 241 in 6c686af

SEARCH_TYPE_HIERARCHY = {

, 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

[ryanmerolle]

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

[jeremystretch]

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

[jeremystretch]

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.