NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-19 11:52:22 -06:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Closes #13182: Support PrimaryModel and OrganizationalModel in plugins (#20919)
Some checks are pending
CI / build (20.x, 3.12) (push) Waiting to run
Details
CI / build (20.x, 3.13) (push) Waiting to run
Details
CI / build (20.x, 3.14) (push) Waiting to run
Details
CodeQL / Analyze (${{ matrix.language }}) (none, actions) (push) Waiting to run
Details
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Waiting to run
Details
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details

Browse Source
This commit is contained in:
Jeremy Stretch
2025-12-09 16:17:21 -05:00
committed by GitHub
parent 17d8f78ae3
commit f56015e03d
7 changed files with 140 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/plugins/development/rest-api.md
View File

@@ -27,6 +27,14 @@ Serializers are responsible for converting Python objects to JSON data suitable
The default nested representation of an object is defined by the `brief_fields` attributes under the serializer's `Meta` class. (Older versions of NetBox required the definition of a separate nested serializer.)
In addition to the base NetBoxModelSerializer class, the following serializer classes are also available for subclasses of standard base models.
| Model Class | Serializer Class |
|-----------------------|--------------------------------------------------------|
| `PrimaryModel` | `netbox.api.serializers.PrimaryModelSerializer` |
| `OrganizationalModel` | `netbox.api.serializers.OrganizationalModelSerializer` |
| `NestedGroupModel` | `netbox.api.serializers.NestedGroupModelSerializer` |
#### Example
To create a serializer for a plugin model, subclass `NetBoxModelSerializer` in `api/serializers.py`. Specify the model class and the fields to include within the serializer's `Meta` class.