From 33e4a7497f156ebf0cac0e429de31b72e628a21a Mon Sep 17 00:00:00 2001 From: Matt Westcott Date: Thu, 22 Oct 2015 17:23:17 +0100 Subject: [PATCH] Release note / documentation update for #1790 --- docs/reference/contrib/api/installation.rst | 3 ++- docs/releases/1.2.rst | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/reference/contrib/api/installation.rst b/docs/reference/contrib/api/installation.rst index 178ffc1e38..f2bfe3f218 100644 --- a/docs/reference/contrib/api/installation.rst +++ b/docs/reference/contrib/api/installation.rst @@ -2,7 +2,7 @@ Wagtail API Installation ======================== -To install, add ``wagtail.contrib.wagtailapi`` to ``INSTALLED_APPS`` in your Django settings and configure a URL for it in ``urls.py`` +To install, add ``wagtail.contrib.wagtailapi`` and ``rest_framework`` to ``INSTALLED_APPS`` in your Django settings and configure a URL for it in ``urls.py``: .. code-block:: python @@ -11,6 +11,7 @@ To install, add ``wagtail.contrib.wagtailapi`` to ``INSTALLED_APPS`` in your Dja INSTALLED_APPS = [ ... 'wagtail.contrib.wagtailapi', + 'rest_framework', ] # urls.py diff --git a/docs/releases/1.2.rst b/docs/releases/1.2.rst index 8ecf059216..ff1f468b79 100644 --- a/docs/releases/1.2.rst +++ b/docs/releases/1.2.rst @@ -45,6 +45,12 @@ See: :ref:`inline_panels` StreamField blocks now :ref:`provide a get_context method ` that can be overridden to pass additional variables to the block's template. +Browsable API +~~~~~~~~~~~~~ + +The Wagtail API now incorporates the browsable front-end provided by Django Rest Framework. Note that this must be enabled by adding ``'rest_framework'`` to your project's ``INSTALLED_APPS`` setting. + + Minor features ~~~~~~~~~~~~~~ @@ -135,3 +141,9 @@ can be rewritten as: .. code-block:: python Image.objects.filter(uploaded_by_user=user).search("Hello") + + +Wagtail API requires adding ``rest_framework`` to INSTALLED_APPS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you have the Wagtail API (``wagtail.contrib.wagtailapi``) enabled, you must now add ``'rest_framework'`` to your project's ``INSTALLED_APPS`` setting. In the current version the API will continue to function without this app, but the browsable front-end will not be available; this ability will be dropped in a future release.