Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-05-24 14:53:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Mark API v1 documentation as deprecated (#3429)

Browse source
This commit is contained in:
Matt Westcott 2017-03-07 10:49:19 +00:00 committed by Karl Hobley
parent 40842fe8bf
commit 60f28f8dc3
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/advanced_topics/api/index.rst
View file

@ -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 <https://github.com/wagtail/wagtail-rfcs/blob/master/accepted/008-wagtail-api.rst#id4>`_
See `RFC 8: Wagtail API <https://github.com/wagtail/rfcs/blob/master/accepted/008-wagtail-api.md#12---stable-and-unstable-versions>`_
for full details on our stabilisation policy.
Version 2 (recommended)

8
docs/reference/contrib/api/index.rst
View file

@ -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.