feat(api): Use JSONField for assigned_object serializer #248
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replaces DictField with JSONField for `assigned_object` to align with NetBox best practices. Ensures missing `assigned_object` returns None without errors. Adds `display` to `brief_fields` for ACLInterfaceAssignment and improves string representation. Fixes: netbox-community#247
pheus
deleted the
housekeeping/247-use-jsonfield-for-assigned-object-serializer
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Related Issue
Fixes: #247 [Housekeeping]: Use JSONField for assigned_object serializer
New Behavior
DictFieldwithJSONFieldforassigned_objectto align with NetBox best practices.assigned_objectreturnsNonewithout errors.displaytobrief_fieldsforACLInterfaceAssignmentand improves its string representation.Contrast to Current Behavior
JSONField, which is the preferred approach in NetBox core.displayattribute toACLInterfaceAssignment, ensuring consistency with other NetBox API objects.Discussion: Benefits and Drawbacks
Changes to the Documentation
Proposed Release Note Entry
Double Check
or in a linked issue.
devbranch.