diff options
| author | Mark Aaron Shirley | 2012-11-20 15:57:54 -0800 | 
|---|---|---|
| committer | Mark Aaron Shirley | 2012-11-20 15:57:54 -0800 | 
| commit | 3b43d41e918b70e5ce83f7da2caabcae2e1bcd72 (patch) | |
| tree | 0e062f766314cf7a6ede55f31b0c7386d7bc48c5 /docs | |
| parent | c3644234cda5c457d72baf1fbf145f12f49a1fa4 (diff) | |
| download | django-rest-framework-3b43d41e918b70e5ce83f7da2caabcae2e1bcd72.tar.bz2 | |
Documentation changes for partial serializer updates
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-guide/serializers.md | 4 | 
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index a9589144..624c4159 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -77,6 +77,10 @@ When deserializing data, we can either create a new instance, or update an exist      serializer = CommentSerializer(data=data)           # Create new instance      serializer = CommentSerializer(comment, data=data)  # Update `instance` +By default, serializers must be passed values for all required fields or they will throw validation errors.  You can use the `partial` argument in order to allow partial updates. + +    serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)  # Update `instance` with partial data +  ## Validation  When deserializing data, you always need to call `is_valid()` before attempting to access the deserialized object.  If any validation errors occur, the `.errors` and `.non_field_errors` properties will contain the resulting error messages.  | 
