Skip to content

Add docs note re generated BooleanField being required=False #5665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 14, 2017
Merged

Add docs note re generated BooleanField being required=False #5665

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f238ce6
Note that BooleanField default is required=False
carltongibson Dec 13, 2017
7f8cb58
Add link to subclass-by-default example
carltongibson Dec 13, 2017
6dda374
Add example link to serializer_field_mapping docs
carltongibson Dec 13, 2017
fb76a2f
Reword Note, Remove link to example.
carltongibson Dec 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api-guide/fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`). If you want to change this behaviour explicitly declare the `BooleanField` on the serializer class.

Corresponds to `django.db.models.fields.BooleanField`.

**Signature:** `BooleanField()`
Expand Down