Skip to content

Commit

Permalink
docs: Bump API version in docs to 1.2
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <[email protected]>
  • Loading branch information
stephenfin committed Dec 27, 2019
1 parent f6b5fe5 commit 7dea5fe
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/api/rest/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.1/
https://patchwork.example.com/api/1.2/

where `patchwork.example.com` refers to the URL of your Patchwork instance.

Expand Down Expand Up @@ -52,16 +52,16 @@ Patchwork instance hosted at `patchwork.example.com`, run:

.. code-block:: shell
$ curl -s 'https://patchwork.example.com/api/1.1/' | python -m json.tool
$ curl -s 'https://patchwork.example.com/api/1.2/' | python -m json.tool
{
"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/"
"bundles": "https://patchwork.example.com/api/1.2/bundles/",
"covers": "https://patchwork.example.com/api/1.2/covers/",
"events": "https://patchwork.example.com/api/1.2/events/",
"patches": "https://patchwork.example.com/api/1.2/patches/",
"people": "https://patchwork.example.com/api/1.2/people/",
"projects": "https://patchwork.example.com/api/1.2/projects/",
"series": "https://patchwork.example.com/api/1.2/series/",
"users": "https://patchwork.example.com/api/1.2/users/"
}
Expand All @@ -74,17 +74,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.1/')
>>> r = requests.get('https://patchwork.example.com/api/1.2/')
>>> print(json.dumps(r.json(), indent=2))
{
"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/"
"bundles": "https://patchwork.example.com/api/1.2/bundles/",
"covers": "https://patchwork.example.com/api/1.2/covers/",
"events": "https://patchwork.example.com/api/1.2/events/",
"patches": "https://patchwork.example.com/api/1.2/patches/",
"people": "https://patchwork.example.com/api/1.2/people/",
"projects": "https://patchwork.example.com/api/1.2/projects/",
"series": "https://patchwork.example.com/api/1.2/series/",
"users": "https://patchwork.example.com/api/1.2/users/"
}
Tools like `curl` and libraries like `requests` can be used to build anything
Expand Down

0 comments on commit 7dea5fe

Please sign in to comment.