Add JSON schema validation for JSON custom fields #10954

New Issue

adam · 2025-12-29T21:38:22+01:00

adam commented

2025-12-29 21:38:22 +01:00

Originally created by @sleepinggenius2 on GitHub (Mar 27, 2025).

NetBox version

v4.2.6

Feature type

Data model extension

Proposed functionality

With the JSON schema infrastructure added to support #19002, I feel like this is finally an appropriate time to make this feature request. A proposal to use regex for the same purpose was previously made in #9236, but I agree that was not a good option. Therefore, my proposal is to add a new schema JSONField to the CustomField data model and add JSONSchema validation when cleaning custom fields. This would be an optional field, just like other custom field validation, to allow for data structure validation only if desired. The addition of the dynamic form rendering when a schema is present would be an interesting further enhancement. A modal or other reference to the schema when entering data would also be a useful solution.

Use case

We have found in our environment a growing interest in leveraging JSON type custom fields to capture some more complex data structures. These are often then fed into scripts or other integrations, so their structure is critical. While custom validators can be used, we have not found that solution to be scalable or user-friendly, as it can often be difficult when working in the UI to remember the exact syntax that is expected and it requires backend administration when changes need to be made.

Database changes

Add an optional schema JSONField to the CustomField data model.

External dependencies

This should only need to leverage the newly introduced jsonschema dependency.

Originally created by @sleepinggenius2 on GitHub (Mar 27, 2025). ### NetBox version v4.2.6 ### Feature type Data model extension ### Proposed functionality With the JSON schema infrastructure added to support #19002, I feel like this is finally an appropriate time to make this feature request. A proposal to use regex for the same purpose was previously made in #9236, but I agree that was not a good option. Therefore, my proposal is to add a new `schema` JSONField to the `CustomField` data model and add JSONSchema validation when cleaning custom fields. This would be an optional field, just like other custom field validation, to allow for data structure validation only if desired. The addition of the dynamic form rendering when a schema is present would be an interesting further enhancement. A modal or other reference to the schema when entering data would also be a useful solution. ### Use case We have found in our environment a growing interest in leveraging JSON type custom fields to capture some more complex data structures. These are often then fed into scripts or other integrations, so their structure is critical. While custom validators can be used, we have not found that solution to be scalable or user-friendly, as it can often be difficult when working in the UI to remember the exact syntax that is expected and it requires backend administration when changes need to be made. ### Database changes Add an optional `schema` JSONField to the `CustomField` data model. ### External dependencies This should only need to leverage the newly introduced `jsonschema` dependency.

adam added the type: feature complexity: medium netbox needs milestone status: backlog labels 2025-12-29 21:38:22 +01:00

adam commented

2025-12-29 21:38:22 +01:00

@jnovinger commented on GitHub (Mar 27, 2025):

As long as we contain this to only custom JSON fields, this seems appropriate to add.

@jnovinger commented on GitHub (Mar 27, 2025): As long as we contain this to only custom JSON fields, this seems appropriate to add.

adam referenced this issue

2025-12-29 23:20:27 +01:00

[PR #10954] [CLOSED] Fixes #10950 - Add filtering and validation to primary_ip4/primary_ip6 VirtualDeviceContext model #13723

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#10954