Add a consistent display field to all REST API serializers #4605

New Issue

adam · 2025-12-29T18:38:10+01:00

adam commented

2025-12-29 18:38:10 +01:00

Originally created by @jeremystretch on GitHub (Feb 27, 2021).

Originally assigned to: @jeremystretch on GitHub.

Environment

Python version: 3.7.9
NetBox version: 2.10.5

Proposed Functionality

Add a new read-only field (e.g. _repr) to all REST API model serializers to convey the normalized representation of each object. This will always be a string suitable for display to a human user.

I'm open to suggestions regarding the specific name, though I am in favor of adopting the leading underscore to indicate a special-use field, in line with _depth on MPTT model serializers (which is used to effect object nesting in rendered selection lists).

Use Case

Establishing a consistent point of reference for API consumers greatly simplifies the logic needed to represent objects to human users. For example, the DynamicModelChoiceField form field accepts a display_field kwarg on initialization. This tells it which attribute of the model to display for each object in the generated selection list. For example, a Prefix will return its prefix attribute, whereas a DeviceType will return its model. Most models return their name.

By ensuring that every serializer includes this standard field, we obviate the need to specify these attributes.

Database Changes

None

External Dependencies

None

Originally created by @jeremystretch on GitHub (Feb 27, 2021). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.7.9 * NetBox version: 2.10.5 ### Proposed Functionality Add a new read-only field (e.g. `_repr`) to all REST API model serializers to convey the normalized representation of each object. This will always be a string suitable for display to a human user. I'm open to suggestions regarding the specific name, though I am in favor of adopting the leading underscore to indicate a special-use field, in line with `_depth` on MPTT model serializers (which is used to effect object nesting in rendered selection lists). ### Use Case Establishing a consistent point of reference for API consumers greatly simplifies the logic needed to represent objects to human users. For example, the DynamicModelChoiceField form field accepts a `display_field` kwarg on initialization. This tells it which attribute of the model to display for each object in the generated selection list. For example, a Prefix will return its `prefix` attribute, whereas a DeviceType will return its `model`. Most models return their `name`. By ensuring that every serializer includes this standard field, we obviate the need to specify these attributes. ### Database Changes None ### External Dependencies None

adam added the status: accepted type: feature labels 2025-12-29 18:38:10 +01:00

adam closed this issue

2025-12-29 18:38:10 +01:00

adam referenced this issue

2025-12-29 22:24:11 +01:00

[PR #4606] [MERGED] Fixes #4605: incorrect DeviceConnectionsReport in reports.md #12885

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