@@ -8,7 +8,7 @@ This guide provides an overview of how one can interact with the REST API. For
8
8
detailed information on type and response format of the various resources
9
9
exposed by the API, refer to the web browsable API. This can be found at:
10
10
11
- https://patchwork.example.com/api/1.2 /
11
+ https://patchwork.example.com/api/1.3 /
12
12
13
13
where `patchwork.example.com ` refers to the URL of your Patchwork instance.
14
14
@@ -38,6 +38,11 @@ If all you want is reference guides, skip straight to :ref:`rest-api-schemas`.
38
38
The API version was bumped to v1.2 in Patchwork v2.2. The older APIs are
39
39
still supported. For more information, refer to :ref: `rest-api-versions `.
40
40
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
+
41
46
Getting Started
42
47
---------------
43
48
@@ -52,16 +57,16 @@ Patchwork instance hosted at `patchwork.example.com`, run:
52
57
53
58
.. code-block :: shell
54
59
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
56
61
{
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/"
65
70
}
66
71
67
72
@@ -74,17 +79,17 @@ well-supported. To repeat the above example using `requests`:, run
74
79
$ python
75
80
>>> import json
76
81
>>> import requests
77
- >>> r = requests.get('https://patchwork.example.com/api/1.2 /')
82
+ >>> r = requests.get('https://patchwork.example.com/api/1.3 /')
78
83
>>> print(json.dumps(r.json(), indent=2))
79
84
{
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/"
88
93
}
89
94
90
95
Tools like `curl ` and libraries like `requests ` can be used to build anything
@@ -103,7 +108,7 @@ Versioning
103
108
----------
104
109
105
110
By default, all requests will receive the latest version of the API: currently
106
- ``1.2 ``:
111
+ ``1.3 ``:
107
112
108
113
.. code-block :: http
109
114
@@ -114,7 +119,7 @@ changes breaking your application:
114
119
115
120
.. code-block :: http
116
121
117
- GET /api/1.2 HTTP/1.1
122
+ GET /api/1.3 HTTP/1.1
118
123
119
124
Older API versions will be deprecated and removed over time. For more
120
125
information, refer to :ref: `rest-api-versions `.
@@ -269,6 +274,7 @@ Supported Versions
269
274
1.0, 2.0, ✓
270
275
1.1, 2.1, ✓
271
276
1.2, 2.2, ✓
277
+ 1.3, 3.1, ✓
272
278
273
279
Further information about this and more can typically be found in
274
280
:doc: `the release notes </releases/index >`.
@@ -285,6 +291,7 @@ Auto-generated schema documentation is provided below.
285
291
/api/rest/schemas/v1.0
286
292
/api/rest/schemas/v1.1
287
293
/api/rest/schemas/v1.2
294
+ /api/rest/schemas/v1.3
288
295
289
296
.. Links
290
297
0 commit comments