diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md new file mode 100644 index 000000000..009d2a79d --- /dev/null +++ b/docs/api-guide/fields.md @@ -0,0 +1,43 @@ + + +# Serializer fields + +> Flat is better than nested. +> +> — [The Zen of Python][cite] + +# Generic Fields + +## Field + +## ModelField + +# Typed Fields + +## BooleanField + +## CharField + +## EmailField + +## DateField + +## DateTimeField + +## IntegerField + +## FloatField + +# Relational Fields + +Relational fields are used to represent model relationships. + +## PrimaryKeyRelatedField + +## ManyPrimaryKeyRelatedField + +## HyperlinkedRelatedField + +## ManyHyperlinkedRelatedField + +[cite]: http://www.python.org/dev/peps/pep-0020/ diff --git a/rest_framework/tests/models.py b/rest_framework/tests/models.py index c90668cad..c5636f35b 100644 --- a/rest_framework/tests/models.py +++ b/rest_framework/tests/models.py @@ -28,25 +28,22 @@ from django.db import models # 'pk': self.id # }) -class Anchor(models.Model): +class RestFrameworkModel(models.Model): """ - A simple model to use as the target of relationships for other test models. + Base for test models that sets app_label, so they play nicely. """ + class Meta: + app_label = 'rest_framework' + abstract = True + + +class Anchor(RestFrameworkModel): text = models.CharField(max_length=100, default='anchor') - class Meta: - app_label = 'rest_framework' - -class BasicModel(models.Model): +class BasicModel(RestFrameworkModel): text = models.CharField(max_length=100) - class Meta: - app_label = 'rest_framework' - -class ManyToManyModel(models.Model): +class ManyToManyModel(RestFrameworkModel): rel = models.ManyToManyField(Anchor) - - class Meta: - app_label = 'rest_framework'