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

Add description & comments fields to all primary models #7064

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

Originally created by @jeremystretch on GitHub (Oct 3, 2022).

Originally assigned to: @jeremystretch on GitHub.

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

Originally created by @jeremystretch on GitHub (Oct 3, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.3.4 ### Feature type Data model extension ### Proposed functionality This issue proposes adding an optional `comments` field to all [primary models](https://docs.netbox.dev/en/stable/development/models/#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_
adam added the status: acceptedtype: feature labels 2025-12-29 19:48:29 +01:00
adam closed this issue 2025-12-29 19:48:30 +01:00
adam commented 2025-12-29 19:48:30 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 3, 2022):

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

@jeremystretch commented on GitHub (Oct 3, 2022): We should also consider adding a `comments` field to all organizational and nested group models.
adam commented 2025-12-29 19:48:31 +01:00
Author
Owner
Copy Link

@jcralbino commented on GitHub (Oct 10, 2022):

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.

@jcralbino commented on GitHub (Oct 10, 2022): 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.
adam commented 2025-12-29 19:48:31 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Nov 3, 2022):

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 commented on GitHub (Nov 3, 2022): 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.
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: feature
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#7064
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?