encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-12 04:37:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #782 from maspwr/writable-nested-modelserializer

Browse Source 
Update docs with allow_add_remove
This commit is contained in:
Tom Christie 2013-04-10 09:16:00 -07:00
commit 56c039ce17
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-guide/serializers.md
View File

@ -244,15 +244,15 @@ This allows you to write views that update or create multiple items when a `PUT`
Bulk updates will update any instances that already exist, and create new instances for data items that do not have a corresponding instance. Bulk updates will update any instances that already exist, and create new instances for data items that do not have a corresponding instance.
When performing a bulk update you may want any items that are not present in the incoming data to be deleted. To do so, pass `allow_delete=True` to the serializer. When performing a bulk update you may want any items that are not present in the incoming data to be deleted. To do so, pass `allow_add_remove=True` to the serializer.
serializer = BookSerializer(queryset, data=data, many=True, allow_delete=True) serializer = BookSerializer(queryset, data=data, many=True, allow_add_remove=True)
serializer.is_valid() serializer.is_valid()
# True # True
serializer.save() # `.save()` will be called on each updated or newly created instance. serializer.save() # `.save()` will be called on each updated or newly created instance.
# `.delete()` will be called on any other items in the `queryset`. # `.delete()` will be called on any other items in the `queryset`.
Passing `allow_delete=True` ensures that any update operations will completely overwrite the existing queryset, rather than simply updating any objects found in the incoming data. Passing `allow_add_remove=True` ensures that any update operations will completely overwrite the existing queryset, rather than simply updating any objects found in the incoming data.
#### How identity is determined when performing bulk updates #### How identity is determined when performing bulk updates