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

Provide a base REST API serializer class for plugins #6186

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

Originally created by @jeremystretch on GitHub (Mar 8, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.2-beta1

Feature type

New functionality

Proposed functionality

Introduce and document a REST API serializer class suitable for use by plugins, to enable features like tagging and custom fields. NetBox core models employ the PrimaryModelSerializer class for this; we can probably just rename this to NetBoxModelSerializer and document accordingly.

Use case

Enables plugins to support tag assignment and custom fields on their models via NetBox's REST API.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Mar 8, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.2-beta1 ### Feature type New functionality ### Proposed functionality Introduce and document a REST API serializer class suitable for use by plugins, to enable features like tagging and custom fields. NetBox core models employ the `PrimaryModelSerializer` class for this; we can probably just rename this to `NetBoxModelSerializer` and document accordingly. ### Use case Enables plugins to support tag assignment and custom fields on their models via NetBox's REST API. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featurebeta labels 2025-12-29 19:37:49 +01:00
adam closed this issue 2025-12-29 19:37:49 +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 beta status: accepted 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#6186
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?