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

Add description & comments fields to all primary models #10545

Closed
jeremystretch opened this issue Oct 3, 2022 · 3 comments
Closed

Add description & comments fields to all primary models #10545

jeremystretch opened this issue Oct 3, 2022 · 3 comments
Assignees
@jeremystretch
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone
v3.4

Comments

@jeremystretch
Copy link
Member

NetBox version

v3.3.4

Feature type

Data model extension

Proposed functionality

This issue proposes adding an optional comments field to all primary models that don't already have one. The list of relevant models includes:

  • dcim.Cable
  • dcim.PowerPanel
  • dcim.RackReservation
  • dcim.VirtualChassis
  • ipam.Aggregate
  • ipam.ASN
  • ipam.FHRPGroup
  • ipam.IPAddress
  • ipam.IPRange
  • ipam.L2VPN
  • ipam.Prefix
  • ipam.RouteTarget
  • ipam.Service
  • ipam.VLAN
  • ipam.VRF
  • wireless.WirelessLAN
  • wireless.WirelessLink

Use case

The application of comment fields to NetBox models has been somewhat arbitrary over time. It's fair to assume a use case for each primary model to have a comments field suitable for storing incidental notes.

Database changes

No response

External dependencies

No response
@jeremystretch jeremystretch added type: feature Introduction of new functionality to the application status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Oct 3, 2022
@jeremystretch jeremystretch mentioned this issue Oct 3, 2022
Closed
@jeremystretch
Copy link
Member Author

We should also consider adding a comments field to all organizational and nested group models.

@jeremystretch jeremystretch mentioned this issue Oct 3, 2022
Closed
@jeremystretch jeremystretch changed the title Add a comments field to all primary models Add a comments field to all primary/organizational models Oct 3, 2022
@jcralbino
Copy link

Can we have this added also to the Image Attachments?
Currently only the Name field can be used to provide additional details but this is limited in size.

@jeremystretch jeremystretch added needs milestone Awaiting prioritization for inclusion with a future NetBox release and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Nov 2, 2022
@jeremystretch jeremystretch self-assigned this Nov 3, 2022
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release labels Nov 3, 2022
@jeremystretch jeremystretch added this to the v3.4 milestone Nov 3, 2022
@jeremystretch jeremystretch changed the title Add a comments field to all primary/organizational models Add description & comments fields to all primary models Nov 3, 2022
@jeremystretch
Copy link
Member Author

Following discussion from today's maintainers meeting, I'm going to refine the scope of this as ensuring all primary models have both a description and comments field to ensure consistency across the application.

@jeremystretch jeremystretch mentioned this issue Nov 3, 2022
Merged
jeremystretch added a commit that referenced this issue Nov 4, 2022
@jeremystretch
Closes #10545: Standardize description & comment fields on primary mo…
bc6b5bc 
…dels (#10834)

* Standardize description & comments fields on primary models

* Update REST API serializers

* Update forms

* Update tables

* Update templates
@jeremystretch jeremystretch mentioned this issue Dec 14, 2022
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2023
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: feature Introduction of new functionality to the application
Projects
None yet
Milestone
v3.4
Development

No branches or pull requests
2 participants
@jeremystretch @jcralbino