aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2013-02-22 20:46:20 +0000
committerTom Christie2013-02-22 20:46:20 +0000
commitb3019d9824c0ba2f907e16202f6e9400ab7ae80e (patch)
treeae2d5e6b2b3db50a77b3868ec0bd99e1bb09ac8e /docs/api-guide
parent0c7d6062b2b327f1fb4051a898212499e33daa54 (diff)
downloaddjango-rest-framework-b3019d9824c0ba2f907e16202f6e9400ab7ae80e.tar.bz2
Note requirements explicitly.
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/parsers.md4
-rw-r--r--docs/api-guide/renderers.md2
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md
index 0cd01639..a2830492 100644
--- a/docs/api-guide/parsers.md
+++ b/docs/api-guide/parsers.md
@@ -69,6 +69,8 @@ Parses `JSON` request content.
Parses `YAML` request content.
+Requires the `pyyaml` package to be installed.
+
**.media_type**: `application/yaml`
## XMLParser
@@ -79,6 +81,8 @@ Note that the `XML` markup language is typically used as the base language for m
If you are considering using `XML` for your API, you may want to consider implementing a custom renderer and parser for your specific requirements, and using an existing domain-specific media-type, or creating your own custom XML-based media-type.
+Requires the `defusedxml` package to be installed.
+
**.media_type**: `application/xml`
## FormParser
diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md
index ca9a6694..5de1491b 100644
--- a/docs/api-guide/renderers.md
+++ b/docs/api-guide/renderers.md
@@ -90,6 +90,8 @@ The javascript callback function must be set by the client including a `callback
Renders the request data into `YAML`.
+Requires the `pyyaml` package to be installed.
+
**.media_type**: `application/yaml`
**.format**: `'.yaml'`