Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove display_name field from all REST API serializers #5991

Closed
jeremystretch opened this issue Mar 16, 2021 · 0 comments
Closed

Remove display_name field from all REST API serializers #5991

jeremystretch opened this issue Mar 16, 2021 · 0 comments
Assignees
@jeremystretch
Labels
status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Milestone
v3.0

Comments

@jeremystretch
Copy link
Member

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.
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user labels Mar 16, 2021
@jeremystretch jeremystretch added this to the v2.12 milestone Mar 16, 2021
@jeremystretch jeremystretch added API change type: deprecation Removal of existing functionality or behavior and removed type: housekeeping Changes to the application which do not directly impact the end user labels Mar 16, 2021
@jeremystretch jeremystretch self-assigned this May 4, 2021
jeremystretch added a commit that referenced this issue May 5, 2021
@jeremystretch
Closes #5991: Remove display_name attribute from serializers
5856275
@jeremystretch jeremystretch mentioned this issue May 5, 2021
Merged
jeremystretch added a commit that referenced this issue May 5, 2021
@jeremystretch
Merge pull request #6352 from netbox-community/5991-remove-display_name
43c17b9 
Closes #5991: Remove display_name
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jeremystretch jeremystretch

Labels
status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Projects
None yet
Milestone
v3.0
Development

No branches or pull requests
1 participant
@jeremystretch