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

Display visual representation when a field is deprecated #7490

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

Originally created by @abhi1693 on GitHub (Jan 11, 2023).

NetBox version

v3.3.10

Feature type

Change to existing functionality

Proposed functionality

I'm wondering is there is a way that a property can be included like deprecated=true on the field and it displays an exclamation mark in a triangle with a tooltip for help text. For starters, this text can be generic like This field will be removed in v3.4. As a user, I'd like to see this visual representation in two places

  • Forms
  • Object views

If a property is not possible, maybe on the model, define a list of fields which can then be translated to UI

Use case

I was trying to run an upgrade from v3.3.10 to 3.4.2 when during half of the upgrade, the issue was raised on the circuit provider fields that I was using legacy data. To my surprise, someone in the system had updated the field without knowing those fields were marked for removal in the next minor version. Had it been known from the UI, this issue could have saved a few hours worth of work to make the proper transition with the new data model.

Database changes

None

External dependencies

None

Originally created by @abhi1693 on GitHub (Jan 11, 2023). ### NetBox version v3.3.10 ### Feature type Change to existing functionality ### Proposed functionality I'm wondering is there is a way that a property can be included like `deprecated=true` on the field and it displays an exclamation mark in a triangle with a tooltip for help text. For starters, this text can be generic like `This field will be removed in v3.4`. As a user, I'd like to see this visual representation in two places - Forms - Object views If a property is not possible, maybe on the model, define a list of fields which can then be translated to UI ### Use case I was trying to run an upgrade from v3.3.10 to 3.4.2 when during half of the upgrade, the issue was raised on the circuit provider fields that I was using legacy data. To my surprise, someone in the system had updated the field without knowing those fields were marked for removal in the next minor version. Had it been known from the UI, this issue could have saved a few hours worth of work to make the proper transition with the new data model. ### Database changes None ### External dependencies None
adam added the type: feature label 2025-12-29 20:24:03 +01:00
adam closed this issue 2025-12-29 20:24:03 +01:00
adam commented 2025-12-29 20:24:03 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Apr 12, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Apr 12, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:24:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 21, 2023):

The only field being deprecated in v3.4 is the account field on the Provider model. I'll add a warning to the UI template for this field, but beyond that I'm not sure there's much else we can adopt as standard practice.

@jeremystretch commented on GitHub (Apr 21, 2023): The only field being deprecated in v3.4 is the `account` field on the Provider model. I'll add a warning to the UI template for this field, but beyond that I'm not sure there's much else we can adopt as standard practice.
adam commented 2025-12-29 20:24:04 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Apr 21, 2023):

As long as such fields are tracked in very release, it does not really matter. I only suggested a potential solution thinking something could come in handy as a standard practice where even plugin developers could also use consistently.

@abhi1693 commented on GitHub (Apr 21, 2023): As long as such fields are tracked in very release, it does not really matter. I only suggested a potential solution thinking something could come in handy as a standard practice where even plugin developers could also use consistently.
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 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#7490
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?