aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2018-05-08 09:18:22 +0100
committerDaniel Axtens <dja@axtens.net>2018-05-09 01:58:58 +1000
commit559187e93f04d28298cfcccb5885b42a61a19310 (patch)
tree8d4b778eaad98da1ffa8fe368545a1e1e71b8f92 /docs/api
parent6b10927e3e5294a33e82240a6c2f10eeca9c257f (diff)
downloadpatchwork-559187e93f04d28298cfcccb5885b42a61a19310.tar
patchwork-559187e93f04d28298cfcccb5885b42a61a19310.tar.gz
docs: Bump API version in docs to 1.1
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>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/rest.rst42
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/api/rest.rst b/docs/api/rest.rst
index d526b27..82a66de 100644
--- a/docs/api/rest.rst
+++ b/docs/api/rest.rst
@@ -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
------