Skip to content

Commit 5ad467a

Browse files
Remove read_only deprecated behaviour from documentation (#9239)
1 parent 41edb3b commit 5ad467a

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/api-guide/validators.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,9 @@ If you want the date field to be entirely hidden from the user, then use `Hidden
173173
# Advanced field defaults
174174

175175
Validators that are applied across multiple fields in the serializer can sometimes require a field input that should not be provided by the API client, but that *is* available as input to the validator.
176+
For this purposes use `HiddenField`. This field will be present in `validated_data` but *will not* be used in the serializer output representation.
176177

177-
Two patterns that you may want to use for this sort of validation include:
178-
179-
* Using `HiddenField`. This field will be present in `validated_data` but *will not* be used in the serializer output representation.
180-
* Using a standard field with `read_only=True`, but that also includes a `default=…` argument. This field *will* be used in the serializer output representation, but cannot be set directly by the user.
178+
**Note:** Using a `read_only=True` field is excluded from writable fields so it won't use a `default=…` argument. Look [3.8 announcement](https://www.django-rest-framework.org/community/3.8-announcement/#altered-the-behaviour-of-read_only-plus-default-on-field).
181179

182180
REST framework includes a couple of defaults that may be useful in this context.
183181

@@ -189,7 +187,7 @@ A default class that can be used to represent the current user. In order to use
189187
default=serializers.CurrentUserDefault()
190188
)
191189

192-
#### CreateOnlyDefault
190+
#### CreateOnlyDefault
193191

194192
A default class that can be used to *only set a default argument during create operations*. During updates the field is omitted.
195193

0 commit comments

Comments
 (0)