aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Christie2012-11-09 17:01:20 +0000
committerTom Christie2012-11-09 17:01:20 +0000
commite224061189a6a5ea2c063f3820239eed6c3a88fb (patch)
treea678827879e7fc25f612c55185c29ed44bdae8da /docs
parentd365621cbeb333d857dd312147edd5cd076866e8 (diff)
downloaddjango-rest-framework-e224061189a6a5ea2c063f3820239eed6c3a88fb.tar.bz2
Support for `read_only_fields` on `ModelSerializer` classes
Diffstat (limited to 'docs')
-rw-r--r--docs/api-guide/serializers.md9
-rw-r--r--docs/topics/release-notes.md4
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md
index 0cdae1ce..a9589144 100644
--- a/docs/api-guide/serializers.md
+++ b/docs/api-guide/serializers.md
@@ -248,6 +248,15 @@ The default `ModelSerializer` uses primary keys for relationships, but you can a
The `depth` option should be set to an integer value that indicates the depth of relationships that should be traversed before reverting to a flat representation.
+## Specifying which fields should be read-only
+
+You may wish to specify multiple fields as read-only. Instead of adding each field explicitely with the `read_only=True` attribute, you may use the `read_only_fields` Meta option, like so:
+
+ class AccountSerializer(serializers.ModelSerializer):
+ class Meta:
+ model = Account
+ read_only_fields = ('created', 'modified')
+
## Customising the default fields
You can create customized subclasses of `ModelSerializer` that use a different set of default fields for the representation, by overriding various `get_<field_type>_field` methods.
diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md
index 670332e6..35e8a8b3 100644
--- a/docs/topics/release-notes.md
+++ b/docs/topics/release-notes.md
@@ -4,6 +4,10 @@
>
> &mdash; Eric S. Raymond, [The Cathedral and the Bazaar][cite].
+## Master
+
+* Support for `read_only_fields` on `ModelSerializer` classes.
+
## 2.1.2
**Date**: 9th Nov 2012