diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 8d61f2cbc..45fdee7ca 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -124,6 +124,8 @@ 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. + Corresponds to `django.db.models.fields.BooleanField`. **Signature:** `BooleanField()` @@ -682,3 +684,4 @@ 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