aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/serializers.md
diff options
context:
space:
mode:
authorJamie Matthews2012-10-24 11:43:30 +0100
committerJamie Matthews2012-10-24 11:43:30 +0100
commitd60d598e0255fb3d55a1213d1025447d83523658 (patch)
tree98eeb416d3190a17d76a8c4f448278ccc065f52c /docs/api-guide/serializers.md
parentac2d39892d6b3fbbe5cd53b9ef83367249ba4880 (diff)
downloaddjango-rest-framework-d60d598e0255fb3d55a1213d1025447d83523658.tar.bz2
Clean up internal names and documentation
Diffstat (limited to 'docs/api-guide/serializers.md')
-rw-r--r--docs/api-guide/serializers.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md
index 40f8a170..50505d30 100644
--- a/docs/api-guide/serializers.md
+++ b/docs/api-guide/serializers.md
@@ -78,7 +78,7 @@ When deserializing data, you always need to call `is_valid()` before attempting
### Field-level validation
-You can specify custom field-level validation by adding `validate_<fieldname>()` methods to your `Serializer` subclass. These are analagous to `clean_<fieldname>` methods on Django forms, but accept slightly different arguments. They take a dictionary of deserialized data as a first argument, and the field name in that data as a second argument (which will be either the name of the field or the value of the `source` argument to the field, if one was provided). Your `validate_<fieldname>` methods should either just return the data dictionary or raise a `ValidationError`. For example:
+You can specify custom field-level validation by adding `validate_<fieldname>()` methods to your `Serializer` subclass. These are analagous to `clean_<fieldname>` methods on Django forms, but accept slightly different arguments. They take a dictionary of deserialized attributes as a first argument, and the field name in that dictionary as a second argument (which will be either the name of the field or the value of the `source` argument to the field, if one was provided). Your `validate_<fieldname>` methods should either just return the attrs dictionary or raise a `ValidationError`. For example:
from rest_framework import serializers
@@ -86,14 +86,14 @@ You can specify custom field-level validation by adding `validate_<fieldname>()`
title = serializers.CharField(max_length=100)
content = serializers.CharField()
- def validate_title(self, data, source):
+ def validate_title(self, attrs, source):
"""
Check that the blog post is about Django
"""
- value = data[source]
+ value = attrs[source]
if "Django" not in value:
raise serializers.ValidationError("Blog post is not about Django")
- return data
+ return attrs
### Final cross-field validation