diff options
| author | Stephen Finucane <stephen@that.guru> | 2018-05-09 18:01:59 +0100 |
|---|---|---|
| committer | Daniel Axtens <dja@axtens.net> | 2018-05-12 02:48:36 +1000 |
| commit | 7b3aef4922c7d73eeb22d90aee16b787e03eb1fd (patch) | |
| tree | 0f0901f0881e8035925699aa32ed4d23640ba395 | |
| parent | 30c8a4909bf8c0dab881464605d669de0f309ccb (diff) | |
| download | patchwork-7b3aef4922c7d73eeb22d90aee16b787e03eb1fd.tar patchwork-7b3aef4922c7d73eeb22d90aee16b787e03eb1fd.tar.gz | |
docs: Add additional information about API versions
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@that.guru>
Signed-off-by: Daniel Axtens <dja@axtens.net>
| -rw-r--r-- | docs/api/rest.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/api/rest.rst b/docs/api/rest.rst index 82a66de..ea43095 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 |