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.

Sign up for GitHub

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

Jump to bottom

Provide a base REST API serializer class for plugins #8823

Closed
Tracked by #8333
jeremystretch opened this issue Mar 8, 2022 · 0 comments
Closed
Tracked by #8333

Provide a base REST API serializer class for plugins #8823

jeremystretch opened this issue Mar 8, 2022 · 0 comments
Assignees
@jeremystretch
Labels
beta Concerns a bug/feature in a beta release status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application

Comments

@jeremystretch
Copy link
Member

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
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application beta Concerns a bug/feature in a beta release labels Mar 8, 2022
@jeremystretch jeremystretch self-assigned this Mar 8, 2022
This was referenced Mar 8, 2022
Closed
Merged
jeremystretch added a commit that referenced this issue Mar 9, 2022
@jeremystretch
Merge pull request #8833 from netbox-community/8823-api-serializers
f559cee 
Closes #8823: Add plugin support for REST API components
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jeremystretch jeremystretch

Labels
beta Concerns a bug/feature in a beta release status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeremystretch