Introduce choice sets for custom fields #8241

New Issue

adam · 2025-12-29T20:34:13+01:00

adam commented

2025-12-29 20:34:13 +01:00

Originally created by @jeremystretch on GitHub (Jun 23, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.5.4

Feature type

Data model extension

Proposed functionality

Currently, custom field choices are stored as an array of values on each applicable CustomField instance:

class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
    choices = ArrayField(
        base_field=models.CharField(max_length=100),
        blank=True,
        null=True,
        help_text=_('Comma-separated list of available choices (for selection fields)')
    )

This issue proposes essentially moving the choices field to a separate model, CustomFieldChoiceSet:

class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
    choices = models.ForeignKey(
        to='CustomFieldChoiceSet',
        blank=True,
        null=True
    )


class CustomFieldChoiceSet(ChangeLoggedModel):
    name = models.CharField()
    description = models.CharField(blank=True)
    choices = ArrayField(
        base_field=models.CharField(max_length=100),
        help_text=_('Comma-separated list of available choices (for selection fields)')
    )

Individual choice values will continue to be managed as flat lists, but now are defined on separate CustomFieldChoiceSet instances, which can be referenced by multiple custom fields.

As part of this work, I'd also like to improve the manner in which custom field choices are managed by the end user. We can extend the current view to allow creating, modifying, and deleting choice values as if they were individual objects (as opposed to a list of values in a single JSON form field).

This will result in a breaking API change for custom fields themselves, however custom field data on NetBox objects should not be affected by the change.

Use case

This change was prompted by #12194, which seeks to introduce reusable choice sets containing well-known values (e.g. UN-LOCODE identifiers). Moving the choice sets into a separate model allows for their efficient reuse across multiple custom fields without introducing significant overhead. (The choice sets can be easily pre-fetched along with the custom fields themselves.)

Database changes

Introduce the new CustomFieldChoiceSet model (above)
Add a ForeignKey from CustomField to CustomFieldChoiceSet
Migrate all existing choices values to new CustomFieldChoiceSet instances
Drop the old choices field from the CustomField model

External dependencies

N/A

Originally created by @jeremystretch on GitHub (Jun 23, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.5.4 ### Feature type Data model extension ### Proposed functionality Currently, custom field choices are stored as an array of values on each applicable `CustomField` instance: ```python class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel): choices = ArrayField( base_field=models.CharField(max_length=100), blank=True, null=True, help_text=_('Comma-separated list of available choices (for selection fields)') ) ``` This issue proposes essentially moving the `choices` field to a separate model, `CustomFieldChoiceSet`: ```python class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel): choices = models.ForeignKey( to='CustomFieldChoiceSet', blank=True, null=True ) class CustomFieldChoiceSet(ChangeLoggedModel): name = models.CharField() description = models.CharField(blank=True) choices = ArrayField( base_field=models.CharField(max_length=100), help_text=_('Comma-separated list of available choices (for selection fields)') ) ``` Individual choice values will continue to be managed as flat lists, but now are defined on separate `CustomFieldChoiceSet` instances, which can be referenced by multiple custom fields. As part of this work, I'd also like to improve the manner in which custom field choices are managed by the end user. We can extend the current view to allow creating, modifying, and deleting choice values as if they were individual objects (as opposed to a list of values in a single JSON form field). This _will_ result in a breaking API change for custom fields themselves, however custom field data on NetBox objects should not be affected by the change. ### Use case This change was prompted by #12194, which seeks to introduce reusable choice sets containing well-known values (e.g. UN-LOCODE identifiers). Moving the choice sets into a separate model allows for their efficient reuse across multiple custom fields without introducing significant overhead. (The choice sets can be easily pre-fetched along with the custom fields themselves.) ### Database changes - Introduce the new CustomFieldChoiceSet model (above) - Add a ForeignKey from CustomField to CustomFieldChoiceSet - Migrate all existing `choices` values to new CustomFieldChoiceSet instances - Drop the old `choices` field from the CustomField model ### External dependencies N/A

adam added the status: accepted type: feature labels 2025-12-29 20:34:13 +01:00

adam closed this issue

2025-12-29 20:34:14 +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#8241