aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortom christie tom@tomchristie.com2011-01-31 08:48:26 +0000
committertom christie tom@tomchristie.com2011-01-31 08:48:26 +0000
commit98b5b2abd8af88271b9f002c4cff878949c08957 (patch)
tree710f6a899b93064735f23f1d686f2876073d1898
parent9024c2e94e27aa7a40882e9beae62e0502fc2677 (diff)
downloaddjango-rest-framework-98b5b2abd8af88271b9f002c4cff878949c08957.tar.bz2
Minor docs changes
-rw-r--r--docs/examples/objectstore.rst2
-rw-r--r--docs/index.rst5
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/examples/objectstore.rst b/docs/examples/objectstore.rst
index 05c750c5..7865242d 100644
--- a/docs/examples/objectstore.rst
+++ b/docs/examples/objectstore.rst
@@ -3,6 +3,8 @@ Resource example - An object store
* http://api.django-rest-framework.org/object-store/
+This example shows an object store API that can be used to store arbitrary serializable content.
+
``urls.py``
.. include:: ../../examples/objectstore/urls.py
diff --git a/docs/index.rst b/docs/index.rst
index 8b273dd7..474788c0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -82,9 +82,12 @@ Or access it from the command line using curl:
.. code-block:: bash
- bash: curl -X POST -H 'X-Requested-With: XMLHttpRequest' --data 'foo=bar' http://api.django-rest-framework.org/simple-example/
+ bash: curl -X POST -H 'X-Requested-With: XMLHttpRequest' --data 'foo=testing' http://api.django-rest-framework.org/simple-example/
{"detail": {"bar": ["This field is required."], "baz": ["This field is required."]}}
+ bash: curl -X POST -H 'X-Requested-With: XMLHttpRequest' -H 'Content-Type: application/json' --data-binary '{"foo":"testing"}' http://api.django-rest-framework.org/simple-example/
+ {"detail": {"bar": ["This field is required."], "baz": ["This field is required."]}}
+
.. note::
TODO: Mention adding custom handler methods, but that the defaults will often do what we want already. Document a Resource example, not tied to models.