Update search index registration in the plugin documentation #117

New Issue

MrUnknownDE · 2026-04-05T16:21:51+02:00

MrUnknownDE commented

2026-04-05 16:21:51 +02:00

Originally created by @pheus on 3/18/2026

Change Type

Correction

Area

Plugins

Proposed Changes

The plugin documentation currently shows registering search indexes with an indexes = [...] list in search.py, while the general search documentation uses @register_search on the SearchIndex class.

Since @register_search is the preferred approach going forward, the plugin documentation should be updated to reflect that. This would keep the examples consistent and make the recommended pattern clearer for plugin authors.

*Originally created by @pheus on 3/18/2026* ### Change Type Correction ### Area Plugins ### Proposed Changes The plugin documentation currently shows registering search indexes with an `indexes = [...]` list in `search.py`, while the general search documentation uses `@register_search` on the `SearchIndex` class. Since `@register_search` is the preferred approach going forward, the plugin documentation should be updated to reflect that. This would keep the examples consistent and make the recommended pattern clearer for plugin authors.

MrUnknownDE closed this issue

2026-04-05 16:21:51 +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 netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted type: documentation type: documentation

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#117