aboutsummaryrefslogtreecommitdiffstats
path: root/docs/topics/browsable-api.md
diff options
context:
space:
mode:
authorTai Lee2013-09-14 00:54:44 +1000
committerTai Lee2013-09-14 00:54:44 +1000
commita9dbd46c9470003a1dd41e66a113d50b0217a110 (patch)
tree37969909ed6c41f550553ffa55287a9a8069ca84 /docs/topics/browsable-api.md
parentbb3261ca489104e3dea434aa11d76f370e938ca8 (diff)
downloaddjango-rest-framework-a9dbd46c9470003a1dd41e66a113d50b0217a110.tar.bz2
Refs #1109 -- Update docs. Integrate changes from feedback.
Diffstat (limited to 'docs/topics/browsable-api.md')
-rw-r--r--docs/topics/browsable-api.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/topics/browsable-api.md b/docs/topics/browsable-api.md
index b2c78f3c..e32db695 100644
--- a/docs/topics/browsable-api.md
+++ b/docs/topics/browsable-api.md
@@ -115,6 +115,7 @@ The context that's available to the template:
* `name` : The name of the resource
* `post_form` : A form instance for use by the POST form (if allowed)
* `put_form` : A form instance for use by the PUT form (if allowed)
+* `display_edit_forms` : A boolean indicating whether or not POST, PUT and PATCH forms will be displayed
* `request` : The request object
* `response` : The response object
* `version` : The version of Django REST Framework
@@ -122,6 +123,8 @@ The context that's available to the template:
* `FORMAT_PARAM` : The view can accept a format override
* `METHOD_PARAM` : The view can accept a method override
+You can override the `BrowsableAPIRenderer.get_context()` method to customise the context that gets passed to the template.
+
#### Not using base.html
For more advanced customization, such as not having a Bootstrap basis or tighter integration with the rest of your site, you can simply choose not to have `api.html` extend `base.html`. Then the page content and capabilities are entirely up to you.