Skip to content

Commit 3f79d5a

Browse files
committed
docs: Bump API version in docs to 1.3
We also need to add missing API documentation pages for this new API version. These should have been added in commit 5b03443 ("api: add auto-generated OpenAPI schema files") Signed-off-by: Stephen Finucane <[email protected]>
1 parent b2a3117 commit 3f79d5a

File tree

3 files changed

+35
-23
lines changed

3 files changed

+35
-23
lines changed

docs/api/rest/index.rst

+28-21
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This guide provides an overview of how one can interact with the REST API. For
88
detailed information on type and response format of the various resources
99
exposed by the API, refer to the web browsable API. This can be found at:
1010

11-
https://patchwork.example.com/api/1.2/
11+
https://patchwork.example.com/api/1.3/
1212

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

@@ -38,6 +38,11 @@ If all you want is reference guides, skip straight to :ref:`rest-api-schemas`.
3838
The API version was bumped to v1.2 in Patchwork v2.2. The older APIs are
3939
still supported. For more information, refer to :ref:`rest-api-versions`.
4040

41+
.. versionchanged:: 3.1
42+
43+
The API version was bumped to v1.3 in Patchwork v3.1. The older APIs are
44+
still supported. For more information, refer to :ref:`rest-api-versions`.
45+
4146
Getting Started
4247
---------------
4348

@@ -52,16 +57,16 @@ Patchwork instance hosted at `patchwork.example.com`, run:
5257

5358
.. code-block:: shell
5459
55-
$ curl -s 'https://patchwork.example.com/api/1.2/' | python -m json.tool
60+
$ curl -s 'https://patchwork.example.com/api/1.3/' | python -m json.tool
5661
{
57-
"bundles": "https://patchwork.example.com/api/1.2/bundles/",
58-
"covers": "https://patchwork.example.com/api/1.2/covers/",
59-
"events": "https://patchwork.example.com/api/1.2/events/",
60-
"patches": "https://patchwork.example.com/api/1.2/patches/",
61-
"people": "https://patchwork.example.com/api/1.2/people/",
62-
"projects": "https://patchwork.example.com/api/1.2/projects/",
63-
"series": "https://patchwork.example.com/api/1.2/series/",
64-
"users": "https://patchwork.example.com/api/1.2/users/"
62+
"bundles": "https://patchwork.example.com/api/1.3/bundles/",
63+
"covers": "https://patchwork.example.com/api/1.3/covers/",
64+
"events": "https://patchwork.example.com/api/1.3/events/",
65+
"patches": "https://patchwork.example.com/api/1.3/patches/",
66+
"people": "https://patchwork.example.com/api/1.3/people/",
67+
"projects": "https://patchwork.example.com/api/1.3/projects/",
68+
"series": "https://patchwork.example.com/api/1.3/series/",
69+
"users": "https://patchwork.example.com/api/1.3/users/"
6570
}
6671
6772
@@ -74,17 +79,17 @@ well-supported. To repeat the above example using `requests`:, run
7479
$ python
7580
>>> import json
7681
>>> import requests
77-
>>> r = requests.get('https://patchwork.example.com/api/1.2/')
82+
>>> r = requests.get('https://patchwork.example.com/api/1.3/')
7883
>>> print(json.dumps(r.json(), indent=2))
7984
{
80-
"bundles": "https://patchwork.example.com/api/1.2/bundles/",
81-
"covers": "https://patchwork.example.com/api/1.2/covers/",
82-
"events": "https://patchwork.example.com/api/1.2/events/",
83-
"patches": "https://patchwork.example.com/api/1.2/patches/",
84-
"people": "https://patchwork.example.com/api/1.2/people/",
85-
"projects": "https://patchwork.example.com/api/1.2/projects/",
86-
"series": "https://patchwork.example.com/api/1.2/series/",
87-
"users": "https://patchwork.example.com/api/1.2/users/"
85+
"bundles": "https://patchwork.example.com/api/1.3/bundles/",
86+
"covers": "https://patchwork.example.com/api/1.3/covers/",
87+
"events": "https://patchwork.example.com/api/1.3/events/",
88+
"patches": "https://patchwork.example.com/api/1.3/patches/",
89+
"people": "https://patchwork.example.com/api/1.3/people/",
90+
"projects": "https://patchwork.example.com/api/1.3/projects/",
91+
"series": "https://patchwork.example.com/api/1.3/series/",
92+
"users": "https://patchwork.example.com/api/1.3/users/"
8893
}
8994
9095
Tools like `curl` and libraries like `requests` can be used to build anything
@@ -103,7 +108,7 @@ Versioning
103108
----------
104109

105110
By default, all requests will receive the latest version of the API: currently
106-
``1.2``:
111+
``1.3``:
107112

108113
.. code-block:: http
109114
@@ -114,7 +119,7 @@ changes breaking your application:
114119

115120
.. code-block:: http
116121
117-
GET /api/1.2 HTTP/1.1
122+
GET /api/1.3 HTTP/1.1
118123
119124
Older API versions will be deprecated and removed over time. For more
120125
information, refer to :ref:`rest-api-versions`.
@@ -269,6 +274,7 @@ Supported Versions
269274
1.0, 2.0, ✓
270275
1.1, 2.1, ✓
271276
1.2, 2.2, ✓
277+
1.3, 3.1, ✓
272278

273279
Further information about this and more can typically be found in
274280
:doc:`the release notes </releases/index>`.
@@ -285,6 +291,7 @@ Auto-generated schema documentation is provided below.
285291
/api/rest/schemas/v1.0
286292
/api/rest/schemas/v1.1
287293
/api/rest/schemas/v1.2
294+
/api/rest/schemas/v1.3
288295

289296
.. Links
290297

docs/api/rest/schemas/v1.2.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
API v1.2 (latest)
2-
=================
1+
API v1.2
2+
========
33

44
.. openapi:: ../../schemas/v1.2/patchwork.yaml
55
:examples:

docs/api/rest/schemas/v1.3.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
API v1.3 (latest)
2+
=================
3+
4+
.. openapi:: ../../schemas/v1.3/patchwork.yaml
5+
:examples:

0 commit comments

Comments
 (0)