diff options
| author | Andrew Donnellan <ajd@linux.ibm.com> | 2019-08-22 17:13:01 +1000 |
|---|---|---|
| committer | Daniel Axtens <dja@axtens.net> | 2019-08-22 21:14:08 +1000 |
| commit | 832d5b61130eb679665201434633b97921f2ef79 (patch) | |
| tree | 75059f0cff16d5ce12f9418eca24039be1f4e81f /docs/api/rest | |
| parent | 15ed7613a08ddf61637a286343968be47640867b (diff) | |
| download | patchwork-832d5b61130eb679665201434633b97921f2ef79.tar patchwork-832d5b61130eb679665201434633b97921f2ef79.tar.gz | |
docs: Add API v1.2
Add API v1.2, including the new fields for list archive URLs.
Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
Diffstat (limited to 'docs/api/rest')
| -rw-r--r-- | docs/api/rest/index.rst | 11 | ||||
| -rw-r--r-- | docs/api/rest/schemas/v1.1.rst | 4 | ||||
| -rw-r--r-- | docs/api/rest/schemas/v1.2.rst | 5 |
3 files changed, 16 insertions, 4 deletions
diff --git a/docs/api/rest/index.rst b/docs/api/rest/index.rst index 1a094d7..d1169e5 100644 --- a/docs/api/rest/index.rst +++ b/docs/api/rest/index.rst @@ -33,6 +33,11 @@ If all you want is reference guides, skip straight to :ref:`rest-api-schemas`. The API version was bumped to v1.1 in Patchwork v2.1. The older v1.0 API is still supported. For more information, refer to :ref:`rest-api-versions`. +.. versionchanged:: 2.2 + + The API version was bumped to v1.2 in Patchwork v2.2. The older APIs are + still supported. For more information, refer to :ref:`rest-api-versions`. + Getting Started --------------- @@ -98,7 +103,7 @@ Versioning ---------- By default, all requests will receive the latest version of the API: currently -``1.1``: +``1.2``: .. code-block:: http @@ -109,7 +114,7 @@ changes breaking your application: .. code-block:: http - GET /api/1.1 HTTP/1.1 + GET /api/1.2 HTTP/1.1 Older API versions will be deprecated and removed over time. For more information, refer to :ref:`rest-api-versions`. @@ -263,6 +268,7 @@ Supported Versions 1.0, 2.0, ✓ 1.1, 2.1, ✓ + 1.2, 2.2, ✓ Further information about this and more can typically be found in :doc:`the release notes </releases/index>`. @@ -278,6 +284,7 @@ Auto-generated schema documentation is provided below. /api/rest/schemas/v1.0 /api/rest/schemas/v1.1 + /api/rest/schemas/v1.2 .. Links diff --git a/docs/api/rest/schemas/v1.1.rst b/docs/api/rest/schemas/v1.1.rst index e18f813..1189f31 100644 --- a/docs/api/rest/schemas/v1.1.rst +++ b/docs/api/rest/schemas/v1.1.rst @@ -1,5 +1,5 @@ -API v1.1 (latest) -================= +API v1.1 +======== .. openapi:: ../../schemas/v1.1/patchwork.yaml :examples: diff --git a/docs/api/rest/schemas/v1.2.rst b/docs/api/rest/schemas/v1.2.rst new file mode 100644 index 0000000..8a96519 --- /dev/null +++ b/docs/api/rest/schemas/v1.2.rst @@ -0,0 +1,5 @@ +API v1.2 (latest) +================= + +.. openapi:: ../../schemas/v1.2/patchwork.yaml + :examples: |