Provide greater flexibility when configuring custom validation rules #5553

New Issue

adam · 2025-12-29T19:29:21+01:00

adam commented

2025-12-29 19:29:21 +01:00

Originally created by @jeremystretch on GitHub (Oct 22, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0.8

Feature type

Change to existing functionality

Proposed functionality

Custom validation was introduced in NetBox v3.0. To declare custom validation rules, an administrator must define the CUSTOM_VALIDATORS configuration parameter, mapping models to their validator classes like this:

CUSTOM_VALIDATORS = {
    'dcim.site': (
        CustomValidator({
            'name': {
                'min_length': 5,
                'max_length': 30,
            }
        }),
    )
}

This FR proposes support for two alternative methods of declaring custom validators (while preserving support for the approach above). First, it should be possible to pass a dictionary of rules directly in place of a CustomValidator instance. For example:

CUSTOM_VALIDATORS = {
    'dcim.site': (
        {
            'name': {
                'min_length': 5,
                'max_length': 30,
            }
        },
    )
}

The dictionary of rules will be passed when instantiating a CustomValidator instance. The second proposed alternative is to allow referencing by path a CustomValidator class defined elsewhere. For example:

CUSTOM_VALIDATORS = {
    'dcim.site': (
        'some_plugin.validators.MyCustomValidator',
    )
}

Use case

Both approaches make it more convenient for users to write portable and repeatable custom validation rules, as they eliminate the need to handle any Python code directly.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Oct 22, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0.8 ### Feature type Change to existing functionality ### Proposed functionality [Custom validation](https://netbox.readthedocs.io/en/stable/customization/custom-validation/) was introduced in NetBox v3.0. To declare custom validation rules, an administrator must define the `CUSTOM_VALIDATORS` configuration parameter, mapping models to their validator classes like this: ``` CUSTOM_VALIDATORS = { 'dcim.site': ( CustomValidator({ 'name': { 'min_length': 5, 'max_length': 30, } }), ) } ``` This FR proposes support for two alternative methods of declaring custom validators (while preserving support for the approach above). First, it should be possible to pass a dictionary of rules directly in place of a CustomValidator instance. For example: ``` CUSTOM_VALIDATORS = { 'dcim.site': ( { 'name': { 'min_length': 5, 'max_length': 30, } }, ) } ``` The dictionary of rules will be passed when instantiating a CustomValidator instance. The second proposed alternative is to allow referencing by path a CustomValidator class defined elsewhere. For example: ``` CUSTOM_VALIDATORS = { 'dcim.site': ( 'some_plugin.validators.MyCustomValidator', ) } ``` ### Use case Both approaches make it more convenient for users to write portable and repeatable custom validation rules, as they eliminate the need to handle any Python code directly. ### Database changes _No response_ ### External dependencies _No response_

adam added the status: accepted type: feature labels 2025-12-29 19:29:21 +01:00

adam closed this issue

2025-12-29 19:29:21 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

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

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#5553