]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: Bump API version in docs to 1.1
authorStephen Finucane <stephen@that.guru>
Tue, 8 May 2018 08:18:22 +0000 (09:18 +0100)
committerDaniel Axtens <dja@axtens.net>
Tue, 8 May 2018 15:58:58 +0000 (01:58 +1000)
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 81e6f8e4 ("docs: Prepare for 2.1.0-rc1")
Cc: Daniel Axtens <dja@axtens.net>
Signed-off-by: Daniel Axtens <dja@axtens.net>
docs/api/rest.rst

index d526b270567c8543e577d56a888d6b3993a03f9a..82a66de1100ce117737f8ff95acc2b16e812b162 100644 (file)
@@ -8,7 +8,7 @@ This guide provides an overview of how one can interact with the REST API. For
 detailed information on type and response format of the various resources
 exposed by the API, refer to the web browsable API. This can be found at:
 
-    https://patchwork.example.com/api/1.0/
+    https://patchwork.example.com/api/1.1/
 
 where `patchwork.example.com` refers to the URL of your Patchwork instance.
 
@@ -39,16 +39,16 @@ Patchwork instance hosted at `patchwork.example.com`, run:
 
 .. code-block:: shell
 
-    $ curl -s 'https://patchwork.example.com/api/1.0/' | python -m json.tool
+    $ curl -s 'https://patchwork.example.com/api/1.1/' | python -m json.tool
     {
-        "bundles": "https://patchwork.example.com/api/1.0/bundles/",
-        "covers": "https://patchwork.example.com/api/1.0/covers/",
-        "events": "https://patchwork.example.com/api/1.0/events/",
-        "patches": "https://patchwork.example.com/api/1.0/patches/",
-        "people": "https://patchwork.example.com/api/1.0/people/",
-        "projects": "https://patchwork.example.com/api/1.0/projects/",
-        "series": "https://patchwork.example.com/api/1.0/series/",
-        "users": "https://patchwork.example.com/api/1.0/users/"
+        "bundles": "https://patchwork.example.com/api/1.1/bundles/",
+        "covers": "https://patchwork.example.com/api/1.1/covers/",
+        "events": "https://patchwork.example.com/api/1.1/events/",
+        "patches": "https://patchwork.example.com/api/1.1/patches/",
+        "people": "https://patchwork.example.com/api/1.1/people/",
+        "projects": "https://patchwork.example.com/api/1.1/projects/",
+        "series": "https://patchwork.example.com/api/1.1/series/",
+        "users": "https://patchwork.example.com/api/1.1/users/"
     }
 
 
@@ -61,17 +61,17 @@ well-supported. To repeat the above example using `requests`:, run
     $ python
     >>> import json
     >>> import requests
-    >>> r = requests.get('https://patchwork.example.com/api/1.0/')
+    >>> r = requests.get('https://patchwork.example.com/api/1.1/')
     >>> print(json.dumps(r.json(), indent=2))
     {
-        "bundles": "https://patchwork.example.com/api/1.0/bundles/",
-        "covers": "https://patchwork.example.com/api/1.0/covers/",
-        "events": "https://patchwork.example.com/api/1.0/events/",
-        "patches": "https://patchwork.example.com/api/1.0/patches/",
-        "people": "https://patchwork.example.com/api/1.0/people/",
-        "projects": "https://patchwork.example.com/api/1.0/projects/",
-        "series": "https://patchwork.example.com/api/1.0/series/",
-        "users": "https://patchwork.example.com/api/1.0/users/"
+        "bundles": "https://patchwork.example.com/api/1.1/bundles/",
+        "covers": "https://patchwork.example.com/api/1.1/covers/",
+        "events": "https://patchwork.example.com/api/1.1/events/",
+        "patches": "https://patchwork.example.com/api/1.1/patches/",
+        "people": "https://patchwork.example.com/api/1.1/people/",
+        "projects": "https://patchwork.example.com/api/1.1/projects/",
+        "series": "https://patchwork.example.com/api/1.1/series/",
+        "users": "https://patchwork.example.com/api/1.1/users/"
     }
 
 Tools like `curl` and libraries like `requests` can be used to build anything
@@ -90,7 +90,7 @@ Versioning
 ----------
 
 By default, all requests will receive the latest version of the API: currently
-``1.0``:
+``1.1``:
 
 .. code-block:: http
 
@@ -101,7 +101,7 @@ changes breaking your application:
 
 .. code-block:: http
 
-    GET /api/1.0 HTTP/1.1
+    GET /api/1.1 HTTP/1.1
 
 Schema
 ------