diff --git a/docs/advanced_topics/api/index.rst b/docs/advanced_topics/api/index.rst index 8df5423d63..d56158b802 100644 --- a/docs/advanced_topics/api/index.rst +++ b/docs/advanced_topics/api/index.rst @@ -11,7 +11,7 @@ There are currently two versions of the API available: v1 and v2. Both versions are "stable" so it is recommended to use v2. V1 is only provided for backwards compatibility and will be removed from Wagtail soon. -See `RFC 8: Wagtail API `_ +See `RFC 8: Wagtail API `_ for full details on our stabilisation policy. Version 2 (recommended) diff --git a/docs/reference/contrib/api/index.rst b/docs/reference/contrib/api/index.rst index 29791e43f8..fb4a875905 100644 --- a/docs/reference/contrib/api/index.rst +++ b/docs/reference/contrib/api/index.rst @@ -1,5 +1,9 @@ -Wagtail API -=========== +Wagtail API v1 +============== + +.. warning:: + + This documentation covers the deprecated version 1 of the API, which is provided for backwards compatibility only. For the current version, see :doc:`/advanced_topics/api/index` The ``wagtailapi`` module can be used to create a read-only, JSON-based API for public Wagtail content.