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.

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

Remove all obsolete nested REST API serializers #17165

Closed
jeremystretch opened this issue Aug 14, 2024 · 0 comments
Closed

Remove all obsolete nested REST API serializers #17165

jeremystretch opened this issue Aug 14, 2024 · 0 comments
Assignees
Labels
breaking change This change modifies or removes some previously documented functionality complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Milestone

Comments

@jeremystretch
Copy link
Member

Proposed Changes

Remove all nested_serializers modules within each app, as these classes are no longer utilized.

Justification

The use of static nested API serializer classes (except where needed to resolve circular imports) was deprecated in NetBox v4.1 under #17143.

Impact

These serializers will no longer be available for use by plugins. They can be replaced by passing nested=True to a model's primary serializer. For example:

device = NestedDeviceSerializer()

can be replaced with

device = DeviceSerializer(nested=True)
@jeremystretch jeremystretch added type: deprecation Removal of existing functionality or behavior breaking change This change modifies or removes some previously documented functionality status: backlog Awaiting selection for work complexity: low Requires minimal effort to implement labels Aug 14, 2024
@jeremystretch jeremystretch added this to the v4.2 milestone Aug 14, 2024
@jeremystretch jeremystretch self-assigned this Oct 18, 2024
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: backlog Awaiting selection for work labels Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This change modifies or removes some previously documented functionality complexity: low Requires minimal effort to implement status: accepted This issue has been accepted for implementation type: deprecation Removal of existing functionality or behavior
Projects
None yet
Development

No branches or pull requests

1 participant