estel/netbox
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

#17143: Update docs for nested serializer use

Browse Source
This commit is contained in:
Jeremy Stretch
2024-08-30 10:18:29 -04:00
parent a6b1f97525
commit 10a74492f6
4 changed files with 7 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/development/adding-models.md
View File

@@ -71,7 +71,6 @@ Add the relevant navigation menu items in `netbox/netbox/navigation/menu.py`.
Create the following for each model:
* Detailed (full) model serializer in `api/serializers.py`
* Nested serializer in `api/nested_serializers.py`
* API view in `api/views.py`
* Endpoint route in `api/urls.py`

2
docs/development/extending-models.md
View File

@@ -50,7 +50,7 @@ If you're adding a relational field (e.g. `ForeignKey`) and intend to include th
## 5. Update API serializer
Extend the model's API serializer in `<app>.api.serializers` to include the new field. In most cases, it will not be necessary to also extend the nested serializer, which produces a minimal representation of the model.
Extend the model's API serializer in `<app>.api.serializers` to include the new field.
## 6. Add fields to forms