Skip to content

Commit e0a6c4b

Browse files
Ryan P Kilbylovelydinosaur
authored andcommitted
Clarify 'to_internal_value()' validation behavior (#5466)
1 parent dc4a98f commit e0a6c4b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/api-guide/serializers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -993,7 +993,7 @@ The following class is an example of a generic serializer that can handle coerci
993993

994994
## Overriding serialization and deserialization behavior
995995

996-
If you need to alter the serialization, deserialization or validation of a serializer class you can do so by overriding the `.to_representation()` or `.to_internal_value()` methods.
996+
If you need to alter the serialization or deserialization behavior of a serializer class, you can do so by overriding the `.to_representation()` or `.to_internal_value()` methods.
997997

998998
Some reasons this might be useful include...
999999

@@ -1011,7 +1011,7 @@ Takes the object instance that requires serialization, and should return a primi
10111011

10121012
Takes the unvalidated incoming data as input and should return the validated data that will be made available as `serializer.validated_data`. The return value will also be passed to the `.create()` or `.update()` methods if `.save()` is called on the serializer class.
10131013

1014-
If any of the validation fails, then the method should raise a `serializers.ValidationError(errors)`. Typically the `errors` argument here will be a dictionary mapping field names to error messages.
1014+
If any of the validation fails, then the method should raise a `serializers.ValidationError(errors)`. The `errors` argument should be a dictionary mapping field names (or `settings.NON_FIELD_ERRORS_KEY`) to a list of error messages. If you don't need to alter deserialization behavior and instead want to provide object-level validation, it's recommended that you intead override the [`.validate()`](#object-level-validation) method.
10151015

10161016
The `data` argument passed to this method will normally be the value of `request.data`, so the datatype it provides will depend on the parser classes you have configured for your API.
10171017

@@ -1155,7 +1155,7 @@ The [html-json-forms][html-json-forms] package provides an algorithm and seriali
11551155

11561156
## QueryFields
11571157

1158-
[djangorestframework-queryfields][djangorestframework-queryfields] allows API clients to specify which fields will be sent in the response via inclusion/exclusion query parameters.
1158+
[djangorestframework-queryfields][djangorestframework-queryfields] allows API clients to specify which fields will be sent in the response via inclusion/exclusion query parameters.
11591159

11601160
## DRF Writable Nested
11611161

0 commit comments

Comments
 (0)