[PATCH 1/2] docs: Add additional information about API versions
Stephen Finucane
stephen at that.guru
Thu May 10 03:01:59 AEST 2018
As we're soon going to be supporting a v1.1 API, we should document what
versions are available and whether they're supported still (hint: we
support both v1.0 and v1.1 at present).
Signed-off-by: Stephen Finucane <stephen at that.guru>
---
docs/api/rest.rst | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/docs/api/rest.rst b/docs/api/rest.rst
index 82a66de1..ea43095c 100644
--- a/docs/api/rest.rst
+++ b/docs/api/rest.rst
@@ -25,6 +25,11 @@ where `patchwork.example.com` refers to the URL of your Patchwork instance.
The REST API was introduced in Patchwork v2.0. Users of earlier Patchwork
versions should instead refer to :doc:`XML-RPC API <xmlrpc>` documentation.
+.. versionchanged:: 2.1
+
+ The API version was bumped to v1.1 in Patchwork v2.1. The older v1.0 API is
+ still supported. For more information, refer to :ref:`rest-api-versions`.
+
Getting Started
---------------
@@ -103,6 +108,9 @@ changes breaking your application:
GET /api/1.1 HTTP/1.1
+Older API versions will be deprecated and removed over time. For more
+information, refer to :ref:`rest-api-versions`.
+
Schema
------
@@ -159,6 +167,11 @@ parameters should be passed as form-encoded data:
$ curl -X PATCH -F 'state=under-review' \
'https://patchwork.example.com/api/patches/123'
+.. versionchanged:: 2.1
+
+ API version 1.1 allows filters to be specified multiple times. Prior to
+ this, only the last value for a given filter key would be used.
+
Authentication
--------------
@@ -222,6 +235,22 @@ The possible ``rel`` values are:
* - ``prev``
- The link relation for the immediate previous page of results.
+.. _rest-api-versions:
+
+Supported Versions
+------------------
+
+.. csv-table::
+ :header: "API Version", "Since", "Supported?"
+
+ 1.0, 2.0, ✓
+ 1.1, 2.1, ✓
+
+Further information about this and more can typically be found in
+:doc:`the release notes </releases/index>`.
+
+.. Links
+
.. _curl: https://curl.haxx.se/
.. _requests: http://docs.python-requests.org/en/master/
.. _Link header: https://tools.ietf.org/html/rfc5988
--
2.14.3
More information about the Patchwork
mailing list