aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorMarko Tibold2012-11-16 23:44:55 +0100
committerMarko Tibold2012-11-16 23:44:55 +0100
commitf801e5d3050591403de04fde7d18522fabc8fe49 (patch)
tree3d57406f990a744ccfa0e28332babb138ca42a3b /docs/api-guide
parentb4cfb46a56c8f7d9bc4340d5443f3a2d57ba9b58 (diff)
downloaddjango-rest-framework-f801e5d3050591403de04fde7d18522fabc8fe49.tar.bz2
Simplified docs a bit for FileField and ImageField.
Added note about MultipartParser only supporting file uploads and Django's default upload handlers.
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/fields.md26
1 files changed, 11 insertions, 15 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index 0b25a6ef..7f42dc5e 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -171,19 +171,11 @@ A file representation. Performs Django's standard FileField validation.
Corresponds to `django.forms.fields.FileField`.
-### Optional arguments
+**Signature:** `FileField(max_length=None, allow_empty_file=False)`
-#### `max_length`
-
-Maximum length for the file name. This value is obtained from the model when used with a ModelSerializer.
-
-Defaults to `None`, meaning validation is skipped.
-
-#### `allow_empty_file`
-
-Determines if empty file uploads are allowed.
-
-Defaults to `False`
+ - `max_length` designates the maximum length for the file name.
+
+ - `allow_empty_file` designates if empty files are allowed.
## ImageField
@@ -191,11 +183,14 @@ An image representation.
Corresponds to `django.forms.fields.ImageField`.
-### Optional arguments
+Requires the `PIL` package.
-Same as FileField.
+Signature and validation is the same as with `FileField`.
-Requires the `PIL` package.
+---
+
+**Note:** `FileFields` and `ImageFields` are only suitable for use with MultiPartParser, since eg json doesn't support file uploads.
+Django's regular [FILE_UPLOAD_HANDLERS] are used for handling uploaded files.
---
@@ -318,3 +313,4 @@ This field is always read-only.
* `slug_url_kwarg` - The named url parameter for the slug field lookup. Default is to use the same value as given for `slug_field`.
[cite]: http://www.python.org/dev/peps/pep-0020/
+[FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS