encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-24 22:24:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Reword Note, Remove link to example.

Browse Source
This commit is contained in:
Carlton Gibson 2017-12-13 16:03:44 +01:00
parent 6dda3743b2
commit fb76a2f676
2 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -124,7 +124,7 @@ A boolean representation.
When using HTML encoded form input be aware that omitting a value will always be treated as setting a field to `False`, even if it has a `default=True` option specified. This is because HTML checkbox inputs represent the unchecked state by omitting the value, so REST framework treats omission as if it is an empty checkbox input.
Note that default `BooleanField` instances will be generated with a `required=False` option (since Django `models.BooleanField` is always `blank=True`). For JSON-only APIs you may wish explicitly declare BooleanFields in order to control this. ([An example configuring serialiser generation to use a `BooleanField` subclass with `required=True` may be found here][required-by-default-boolean-field].)
Note that default `BooleanField` instances will be generated with a `required=False` option (since Django `models.BooleanField` is always `blank=True`). If you want to change this behaviour explicitly declare the `BooleanField` on the serializer class.
Corresponds to `django.db.models.fields.BooleanField`.
@ -684,4 +684,3 @@ The [django-rest-framework-hstore][django-rest-framework-hstore] package provide
[django-rest-framework-hstore]: https://github.com/djangonauts/django-rest-framework-hstore
[django-hstore]: https://github.com/djangonauts/django-hstore
[python-decimal-rounding-modes]: https://docs.python.org/3/library/decimal.html#rounding-modes
[required-by-default-boolean-field]: http://notes.noumenal.es/2017/12/13/required-by-default.html

4
docs/api-guide/serializers.md
View File

@ -588,7 +588,7 @@ Normally if a `ModelSerializer` does not generate the fields you need by default
### `.serializer_field_mapping`
A mapping of Django model classes to REST framework serializer classes. You can override this mapping to alter the default serializer classes that should be used for each model class. ([An example using `serializer_field_mapping` with a `BooleanField` subclass may be found here][required-by-default-boolean-field].)
A mapping of Django model classes to REST framework serializer classes. You can override this mapping to alter the default serializer classes that should be used for each model class.
### `.serializer_related_field`
@ -1181,5 +1181,3 @@ The [drf-writable-nested][drf-writable-nested] package provides writable nested
[drf-serializer-extensions]: https://github.com/evenicoulddoit/django-rest-framework-serializer-extensions
[djangorestframework-queryfields]: http://djangorestframework-queryfields.readthedocs.io/
[drf-writable-nested]: http://github.com/beda-software/drf-writable-nested
[required-by-default-boolean-field]: http://notes.noumenal.es/2017/12/13/required-by-default.html