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>

diff --git a/docs/api/rest.rst b/docs/api/rest.rst
index 75e31f6fb120bad4eb4740e71676cf25599aade2..17509134eabcd37b9f336b814f73b49fab6e7d25 100644 (file)
--- 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
 ------
 

diff --git a/patchwork/urls.py b/patchwork/urls.py
index 8c8c172fe7a24b56eea5d597ec8cad57cfb4d289..f700f38633122e4a553aec03da635fba8d15d0c1 100644 (file)
--- a/patchwork/urls.py
+++ b/patchwork/urls.py
@@ -232,7 +232,7 @@ if settings.ENABLE_REST_API:
     ]
 
     urlpatterns += [
-        url(r'^api/(?P<version>(1.0))/', include(api_patterns)),
+        url(r'^api/(?:(?P<version>(1.0))/)?', include(api_patterns)),
     ]