starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Remove display_name field from all REST API serializers #4668

New Issue
Closed
opened 2025-12-29 19:19:19 +01:00 by adam · 0 comments
adam commented 2025-12-29 19:19:19 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Mar 16, 2021).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Remove the display_name field from serializers that have it. Any REST API consumers that were utilizing these fields should be updated to reference display instead. The complete list of affected serializers is below:

  • dcim.Device
  • dcim.DeviceType
  • dcim.Rack
  • extras.ContentType
  • ipam.VLAN
  • ipam.VRF

Justification

The display_name field has been superseded in #5891 by the new standard display field, which is available on all models.

Originally created by @jeremystretch on GitHub (Mar 16, 2021). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Remove the `display_name` field from serializers that have it. Any REST API consumers that were utilizing these fields should be updated to reference `display` instead. The complete list of affected serializers is below: * dcim.Device * dcim.DeviceType * dcim.Rack * extras.ContentType * ipam.VLAN * ipam.VRF ### Justification The `display_name` field has been superseded in #5891 by the new standard `display` field, which is available on all models.
adam added the status: acceptedtype: deprecation labels 2025-12-29 19:19:19 +01:00
adam closed this issue 2025-12-29 19:19:20 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: deprecation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4668
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?