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

Establish consistent naming strategy for model fields & filters #11296

New Issue
Open
opened 2025-12-29 21:43:13 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:43:13 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jun 20, 2025).

Proposed Changes

Devise and document a comprehensive strategy for naming the following:

  • Model fields
  • Reverse relations (e.g. related_name)
  • Generic relations
  • Filters

There may be additional elements applicable for inclusion here. An in-depth audit of the code is necessary to identify a prudent scope for these changes.

Justification

There are many instances where the names of these elements differ unexpectedly, stemming from organic growth over time and the absence of a clear directive.

For instance, the PowerFeed model has a reverse relation on the Rack model named powerfeeds, but its reverse relation from Tenant is named power_feeds. Neither of these is necessarily incorrect, but the same name should be used in both cases.

Originally created by @jeremystretch on GitHub (Jun 20, 2025). ### Proposed Changes Devise and document a comprehensive strategy for naming the following: - Model fields - Reverse relations (e.g. `related_name`) - Generic relations - Filters There may be additional elements applicable for inclusion here. An in-depth audit of the code is necessary to identify a prudent scope for these changes. ### Justification There are many instances where the names of these elements differ unexpectedly, stemming from organic growth over time and the absence of a clear directive. For instance, the PowerFeed model has a reverse relation on the Rack model named `powerfeeds`, but its reverse relation from Tenant is named `power_feeds`. Neither of these is necessarily incorrect, but the same name should be used in both cases.
adam added the type: housekeepingnetboxstatus: backlog labels 2025-12-29 21:43:13 +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 netbox status: backlog type: housekeeping
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#11296
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?