aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorJens Alm2012-10-15 13:46:44 +0200
committerJens Alm2012-10-15 13:46:44 +0200
commitc94272650915eef368cdc5d157644884c3eecccb (patch)
tree2cf1ca191bd1136664e12ac898eb8ebe67410b32 /docs/api-guide
parentafbc9684f2108f6fd0ad4ef0ab4c5d19953c1561 (diff)
downloaddjango-rest-framework-c94272650915eef368cdc5d157644884c3eecccb.tar.bz2
Added docs, integer fields and refactored models.TextField to use CharField
I realized that per the django forms, there is no need for a separate TextField, an unlimited CharField is perfectly good. Also added default field for the different IntegerField types
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/fields.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index df54ea02..dc9ab045 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -73,18 +73,35 @@ These fields represent basic datatypes, and support both reading and writing val
## BooleanField
+A Boolean representation, corresponds to `django.db.models.fields.BooleanField`.
+
## CharField
+A text representation, optionally validates the text to be shorter than `max_length` and longer than `min_length`, corresponds to `django.db.models.fields.CharField`
+or `django.db.models.fields.TextField`.
+
+**Signature:** `CharField([max_length=<Integer>[, min_length=<Integer>]])`
+
## EmailField
+A text representation, validates the text to be a valid e-mail adress. Corresponds to `django.db.models.fields.EmailField`
+
## DateField
+A date representation. Corresponds to `django.db.models.fields.DateField`
+
## DateTimeField
+A date and time representation. Corresponds to `django.db.models.fields.DateTimeField`
+
## IntegerField
+An integer representation. Corresponds to `django.db.models.fields.IntegerField`, `django.db.models.fields.SmallIntegerField`, `django.db.models.fields.PositiveIntegerField` and `django.db.models.fields.PositiveSmallIntegerField`
+
## FloatField
+A floating point representation. Corresponds to `django.db.models.fields.FloatField`.
+
---
# Relational Fields