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 #8833] [MERGED] Closes #8823: Add plugin support for REST API components #13397

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

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/8833
Author: @jeremystretch
Created: 3/9/2022
Status: ✅ Merged
Merged: 3/9/2022
Merged by: @jeremystretch

Base: feature ← Head: 8823-api-serializers

📝 Commits (4)

  • a11abf8 Refactor API serializers
  • efd5a73 Refactor API views
  • bbdeae0 Move CustomFieldModelViewSet functionality into NetBoxModelViewSet
  • e36ae4f Document support for NetBoxModelSerializer, NetBoxModelViewSet

📊 Changes

23 files changed (+695 additions, -658 deletions)

View changed files

📝 docs/plugins/development/rest-api.md (+27 -10)
📝 netbox/circuits/api/serializers.py (+5 -5)
📝 netbox/circuits/api/views.py (+6 -7)
📝 netbox/dcim/api/serializers.py (+27 -27)
📝 netbox/dcim/api/views.py (+41 -41)
📝 netbox/extras/api/views.py (+9 -27)
📝 netbox/ipam/api/serializers.py (+17 -17)
📝 netbox/ipam/api/views.py (+18 -19)
➖ netbox/netbox/api/serializers.py (+0 -193)
➕ netbox/netbox/api/serializers/__init__.py (+27 -0)
➕ netbox/netbox/api/serializers/base.py (+43 -0)
➕ netbox/netbox/api/serializers/features.py (+80 -0)
➕ netbox/netbox/api/serializers/nested.py (+62 -0)
📝 netbox/netbox/api/views.py (+0 -275)
➕ netbox/netbox/api/viewsets/__init__.py (+182 -0)
➕ netbox/netbox/api/viewsets/mixins.py (+113 -0)
📝 netbox/tenancy/api/serializers.py (+5 -5)
📝 netbox/tenancy/api/views.py (+8 -8)
📝 netbox/users/api/views.py (+5 -5)
📝 netbox/virtualization/api/serializers.py (+6 -6)

...and 3 more files

📄 Description

Closes: #8823

  • Reorganize and refactor core API classes
  • Rename ModelViewSet to NetBoxModelViewSet
  • Rename PrimaryModelSerializer to NetBoxModelSerializer
  • Move CustomFieldModelViewSet functionality into NetBoxModelViewSet
  • Document support for NetBoxModelSerializer and NetBoxModelViewSet

🔄 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/8833 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 3/9/2022 **Status:** ✅ Merged **Merged:** 3/9/2022 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `feature` ← **Head:** `8823-api-serializers` --- ### 📝 Commits (4) - [`a11abf8`](https://github.com/netbox-community/netbox/commit/a11abf87ec5980fb518202fa46f05307c1cd86f6) Refactor API serializers - [`efd5a73`](https://github.com/netbox-community/netbox/commit/efd5a73a187f1183a278595d7345046abee5800b) Refactor API views - [`bbdeae0`](https://github.com/netbox-community/netbox/commit/bbdeae0ed9bcc06fb96ffa2970272e1a3447448c) Move CustomFieldModelViewSet functionality into NetBoxModelViewSet - [`e36ae4f`](https://github.com/netbox-community/netbox/commit/e36ae4f0f71e3ffe96fef9c9d1c5864a12322089) Document support for NetBoxModelSerializer, NetBoxModelViewSet ### 📊 Changes **23 files changed** (+695 additions, -658 deletions) <details> <summary>View changed files</summary> 📝 `docs/plugins/development/rest-api.md` (+27 -10) 📝 `netbox/circuits/api/serializers.py` (+5 -5) 📝 `netbox/circuits/api/views.py` (+6 -7) 📝 `netbox/dcim/api/serializers.py` (+27 -27) 📝 `netbox/dcim/api/views.py` (+41 -41) 📝 `netbox/extras/api/views.py` (+9 -27) 📝 `netbox/ipam/api/serializers.py` (+17 -17) 📝 `netbox/ipam/api/views.py` (+18 -19) ➖ `netbox/netbox/api/serializers.py` (+0 -193) ➕ `netbox/netbox/api/serializers/__init__.py` (+27 -0) ➕ `netbox/netbox/api/serializers/base.py` (+43 -0) ➕ `netbox/netbox/api/serializers/features.py` (+80 -0) ➕ `netbox/netbox/api/serializers/nested.py` (+62 -0) 📝 `netbox/netbox/api/views.py` (+0 -275) ➕ `netbox/netbox/api/viewsets/__init__.py` (+182 -0) ➕ `netbox/netbox/api/viewsets/mixins.py` (+113 -0) 📝 `netbox/tenancy/api/serializers.py` (+5 -5) 📝 `netbox/tenancy/api/views.py` (+8 -8) 📝 `netbox/users/api/views.py` (+5 -5) 📝 `netbox/virtualization/api/serializers.py` (+6 -6) _...and 3 more files_ </details> ### 📄 Description ### Closes: #8823 - Reorganize and refactor core API classes - Rename ModelViewSet to NetBoxModelViewSet - Rename PrimaryModelSerializer to NetBoxModelSerializer - Move CustomFieldModelViewSet functionality into NetBoxModelViewSet - Document support for NetBoxModelSerializer and NetBoxModelViewSet --- <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-29 22:27:10 +01:00
adam closed this issue 2025-12-29 22:27:11 +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#13397
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?