From f223cf70e9d0190df401ceab4020bb8574c69164 Mon Sep 17 00:00:00 2001 From: Juan Riaza Date: Sat, 5 Jan 2013 23:43:53 +0100 Subject: [PATCH] docs --- README.md | 5 ++++- docs/api-guide/parsers.md | 6 ++++++ docs/api-guide/renderers.md | 8 ++++++++ docs/index.md | 4 ++++ 4 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a9149cf1..1c5c56e22 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ There is also a sandbox API you can use for testing purposes, [available here][s * [Markdown] - Markdown support for the self describing API. * [PyYAML] - YAML content type support. +* [msgpack-python] - MessagePack content type support. +* [python-dateutil] - Date parsing for MessagePack. * [django-filter] - Filtering support. # Installation @@ -284,4 +286,5 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [markdown]: http://pypi.python.org/pypi/Markdown/ [pyyaml]: http://pypi.python.org/pypi/PyYAML [django-filter]: https://github.com/alex/django-filter - +[msgpack-python]: https://github.com/msgpack/msgpack-python +[python-dateutil]: http://labix.org/python-dateutil diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md index 185b616cb..3fed786d7 100644 --- a/docs/api-guide/parsers.md +++ b/docs/api-guide/parsers.md @@ -61,6 +61,12 @@ Parses `YAML` request content. **.media_type**: `application/yaml` +## MessagePackParser + +Parses `MessagePack` request content. + +**.media_type**: `application/msgpack` + ## XMLParser Parses REST framework's default style of `XML` request content. diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 374ff0ab2..c4d160961 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -94,6 +94,14 @@ Renders the request data into `YAML`. **.format**: `'.yaml'` +## MessagePackRenderer + +Renders the request data into `MessagePack`. + +**.media_type**: `application/msgpack` + +**.format**: `'.msgpack'` + ## XMLRenderer Renders REST framework's default style of `XML` response content. diff --git a/docs/index.md b/docs/index.md index 080eca6f2..483482c3c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,6 +35,8 @@ The following packages are optional: * [Markdown][markdown] (2.1.0+) - Markdown support for the browseable API. * [PyYAML][yaml] (3.10+) - YAML content-type support. * [django-filter][django-filter] (0.5.4+) - Filtering support. +* [python-dateutil] - Date parsing for MessagePack. +* [django-filter] - Filtering support. ## Installation @@ -167,6 +169,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [markdown]: http://pypi.python.org/pypi/Markdown/ [yaml]: http://pypi.python.org/pypi/PyYAML [django-filter]: https://github.com/alex/django-filter +[msgpack-python]: https://github.com/msgpack/msgpack-python +[python-dateutil]: http://labix.org/python-dateutil [0.4]: https://github.com/tomchristie/django-rest-framework/tree/0.4.X [image]: img/quickstart.png [sandbox]: http://restframework.herokuapp.com/