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

[PR #17164] [MERGED] Closes #17143: Deprecate the use of dedicated nested API serializers #15013

New Issue
Closed
opened 2025-12-30 00:19:27 +01:00 by adam · 0 comments
adam commented 2025-12-30 00:19:27 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/17164
Author: @jeremystretch
Created: 8/14/2024
Status: ✅ Merged
Merged: 8/15/2024
Merged by: @jeremystretch

Base: feature ← Head: 17143-deprecate-nested-serializers

📝 Commits (1)

  • 646244f Closes #17143: Deprecate the use of dedicated nested API serializers

📊 Changes

40 files changed (+345 additions, -217 deletions)

View changed files

📝 netbox/circuits/api/nested_serializers.py (+9 -12)
📝 netbox/circuits/api/serializers.py (+0 -1)
➕ netbox/circuits/api/serializers_/nested.py (+13 -0)
📝 netbox/circuits/api/serializers_/providers.py (+1 -1)
📝 netbox/core/api/nested_serializers.py (+8 -0)
📝 netbox/core/api/serializers.py (+0 -1)
📝 netbox/dcim/api/nested_serializers.py (+12 -82)
📝 netbox/dcim/api/serializers.py (+0 -1)
📝 netbox/dcim/api/serializers_/device_components.py (+2 -2)
📝 netbox/dcim/api/serializers_/devices.py (+1 -1)
📝 netbox/dcim/api/serializers_/devicetype_components.py (+1 -1)
➕ netbox/dcim/api/serializers_/nested.py (+98 -0)
📝 netbox/dcim/api/serializers_/sites.py (+1 -1)
📝 netbox/dcim/api/serializers_/virtualchassis.py (+1 -1)
📝 netbox/extras/api/nested_serializers.py (+8 -0)
📝 netbox/extras/api/serializers.py (+0 -1)
📝 netbox/ipam/api/nested_serializers.py (+9 -13)
📝 netbox/ipam/api/serializers.py (+0 -1)
📝 netbox/ipam/api/serializers_/ip.py (+1 -1)
➕ netbox/ipam/api/serializers_/nested.py (+18 -0)

...and 20 more files

📄 Description

Closes: #17143

  • Relocate all nested serializer classes that are still required (i.e. to avoid circular imports) to a new nested module within api/serializers_/ under each app.
  • Remove all imports of the nested_serializers modules.
  • Raise a DeprecationWarning when importing any of the now-obsolete nested_serializers modules. These will be completely removed in NetBox v4.2 per #17165.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/17164 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 8/14/2024 **Status:** ✅ Merged **Merged:** 8/15/2024 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `feature` ← **Head:** `17143-deprecate-nested-serializers` --- ### 📝 Commits (1) - [`646244f`](https://github.com/netbox-community/netbox/commit/646244f75dff9d40419347701ca955a1dd8757b1) Closes #17143: Deprecate the use of dedicated nested API serializers ### 📊 Changes **40 files changed** (+345 additions, -217 deletions) <details> <summary>View changed files</summary> 📝 `netbox/circuits/api/nested_serializers.py` (+9 -12) 📝 `netbox/circuits/api/serializers.py` (+0 -1) ➕ `netbox/circuits/api/serializers_/nested.py` (+13 -0) 📝 `netbox/circuits/api/serializers_/providers.py` (+1 -1) 📝 `netbox/core/api/nested_serializers.py` (+8 -0) 📝 `netbox/core/api/serializers.py` (+0 -1) 📝 `netbox/dcim/api/nested_serializers.py` (+12 -82) 📝 `netbox/dcim/api/serializers.py` (+0 -1) 📝 `netbox/dcim/api/serializers_/device_components.py` (+2 -2) 📝 `netbox/dcim/api/serializers_/devices.py` (+1 -1) 📝 `netbox/dcim/api/serializers_/devicetype_components.py` (+1 -1) ➕ `netbox/dcim/api/serializers_/nested.py` (+98 -0) 📝 `netbox/dcim/api/serializers_/sites.py` (+1 -1) 📝 `netbox/dcim/api/serializers_/virtualchassis.py` (+1 -1) 📝 `netbox/extras/api/nested_serializers.py` (+8 -0) 📝 `netbox/extras/api/serializers.py` (+0 -1) 📝 `netbox/ipam/api/nested_serializers.py` (+9 -13) 📝 `netbox/ipam/api/serializers.py` (+0 -1) 📝 `netbox/ipam/api/serializers_/ip.py` (+1 -1) ➕ `netbox/ipam/api/serializers_/nested.py` (+18 -0) _...and 20 more files_ </details> ### 📄 Description ### Closes: #17143 - Relocate all nested serializer classes that are still required (i.e. to avoid circular imports) to a new `nested` module within `api/serializers_/` under each app. - Remove all imports of the `nested_serializers` modules. - Raise a `DeprecationWarning` when importing any of the now-obsolete `nested_serializers` modules. These will be completely removed in NetBox v4.2 per #17165. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:19:27 +01:00
adam closed this issue 2025-12-30 00:19:27 +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 pull-request
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#15013
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?