diff options
| author | Stephen Finucane <stephen@that.guru> | 2017-04-27 00:58:04 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2017-04-28 23:52:04 +0100 |
| commit | 868f63b0e366f442cfa158db6ecea8e1027491f1 (patch) | |
| tree | a0b5353c9aac16228680540d28965c05750e620c /docs/api | |
| parent | 5094cfdbf0b11af44f979b16e43e8cce36378322 (diff) | |
| download | patchwork-868f63b0e366f442cfa158db6ecea8e1027491f1.tar patchwork-868f63b0e366f442cfa158db6ecea8e1027491f1.tar.gz | |
REST: Allow users to omit version entirely
This is super handy for debugging/development of Patchwork and Patchwork
clients alike.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/rest.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/api/rest.rst b/docs/api/rest.rst index 75e31f6..1750913 100644 --- a/docs/api/rest.rst +++ b/docs/api/rest.rst @@ -86,6 +86,23 @@ overview of existing API clients, refer to :doc:`../usage/clients`. own instance of Patchwork locally <../development/installation>` and experiment with that instead. +Versioning +---------- + +By default, all requests will receive the latest version of the API: currently +``1.0``: + +.. code-block:: http + + GET /api HTTP/1.1 + +You should explicitly request this version through the URL to prevent API +changes breaking your application: + +.. code-block:: http + + GET /api/1.0 HTTP/1.1 + Schema ------ |