encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-09-17 01:32:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation regarding arguments of ValidationError

Browse Source 
The documentation used to state that the `detail` argument was
mandatory, but in fact it currently is not.
This commit is contained in:
Bernhard Mallinger 2022-12-22 11:58:09 +01:00
parent 48a21aa0eb
commit 4b624cd940
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api-guide/exceptions.md
View File

@ -217,11 +217,10 @@ By default this exception results in a response with the HTTP status code "429 T
## ValidationError
**Signature:** `ValidationError(detail, code=None)`
**Signature:** `ValidationError(detail=None, code=None)`
The `ValidationError` exception is slightly different from the other `APIException` classes:
* The `detail` argument is mandatory, not optional.
* The `detail` argument may be a list or dictionary of error details, and may also be a nested data structure. By using a dictionary, you can specify field-level errors while performing object-level validation in the `validate()` method of a serializer. For example. `raise serializers.ValidationError({'name': 'Please enter a valid name.'})`
* By convention you should import the serializers module and use a fully qualified `ValidationError` style, in order to differentiate it from Django's built-in validation error. For example. `raise serializers.ValidationError('This field must be an integer value.')`