From a5f0cac0a0b4def01e8e4ca66b48805c9c21208a Mon Sep 17 00:00:00 2001 From: andrepapoti Date: Mon, 18 Mar 2024 15:54:34 -0300 Subject: [PATCH] release-notes: Add release notes for the Series linking feature Closes #506 Signed-off-by: andrepapoti --- docs/api/rest/index.rst | 46 ++++++++++--------- docs/api/rest/schemas/v1.3.rst | 2 +- docs/api/rest/schemas/v1.4.rst | 5 ++ .../notes/issue-506-ce13fcdc4523a300.yaml | 10 ++++ 4 files changed, 40 insertions(+), 23 deletions(-) create mode 100644 docs/api/rest/schemas/v1.4.rst create mode 100644 releasenotes/notes/issue-506-ce13fcdc4523a300.yaml diff --git a/docs/api/rest/index.rst b/docs/api/rest/index.rst index 67022e6f3..37ef4119d 100644 --- a/docs/api/rest/index.rst +++ b/docs/api/rest/index.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.3/ + https://patchwork.example.com/api/1.4/ where `patchwork.example.com` refers to the URL of your Patchwork instance. @@ -40,7 +40,7 @@ If all you want is reference guides, skip straight to :ref:`rest-api-schemas`. .. versionchanged:: 3.1 - The API version was bumped to v1.3 in Patchwork v3.1. The older APIs are + The API version was bumped to v1.4 in Patchwork v3.1. The older APIs are still supported. For more information, refer to :ref:`rest-api-versions`. Getting Started @@ -57,16 +57,16 @@ Patchwork instance hosted at `patchwork.example.com`, run: .. code-block:: shell - $ curl -s 'https://patchwork.example.com/api/1.3/' | python -m json.tool + $ curl -s 'https://patchwork.example.com/api/1.4/' | python -m json.tool { - "bundles": "https://patchwork.example.com/api/1.3/bundles/", - "covers": "https://patchwork.example.com/api/1.3/covers/", - "events": "https://patchwork.example.com/api/1.3/events/", - "patches": "https://patchwork.example.com/api/1.3/patches/", - "people": "https://patchwork.example.com/api/1.3/people/", - "projects": "https://patchwork.example.com/api/1.3/projects/", - "series": "https://patchwork.example.com/api/1.3/series/", - "users": "https://patchwork.example.com/api/1.3/users/" + "bundles": "https://patchwork.example.com/api/1.4/bundles/", + "covers": "https://patchwork.example.com/api/1.4/covers/", + "events": "https://patchwork.example.com/api/1.4/events/", + "patches": "https://patchwork.example.com/api/1.4/patches/", + "people": "https://patchwork.example.com/api/1.4/people/", + "projects": "https://patchwork.example.com/api/1.4/projects/", + "series": "https://patchwork.example.com/api/1.4/series/", + "users": "https://patchwork.example.com/api/1.4/users/" } @@ -79,17 +79,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.3/') + >>> r = requests.get('https://patchwork.example.com/api/1.4/') >>> print(json.dumps(r.json(), indent=2)) { - "bundles": "https://patchwork.example.com/api/1.3/bundles/", - "covers": "https://patchwork.example.com/api/1.3/covers/", - "events": "https://patchwork.example.com/api/1.3/events/", - "patches": "https://patchwork.example.com/api/1.3/patches/", - "people": "https://patchwork.example.com/api/1.3/people/", - "projects": "https://patchwork.example.com/api/1.3/projects/", - "series": "https://patchwork.example.com/api/1.3/series/", - "users": "https://patchwork.example.com/api/1.3/users/" + "bundles": "https://patchwork.example.com/api/1.4/bundles/", + "covers": "https://patchwork.example.com/api/1.4/covers/", + "events": "https://patchwork.example.com/api/1.4/events/", + "patches": "https://patchwork.example.com/api/1.4/patches/", + "people": "https://patchwork.example.com/api/1.4/people/", + "projects": "https://patchwork.example.com/api/1.4/projects/", + "series": "https://patchwork.example.com/api/1.4/series/", + "users": "https://patchwork.example.com/api/1.4/users/" } Tools like `curl` and libraries like `requests` can be used to build anything @@ -108,7 +108,7 @@ Versioning ---------- By default, all requests will receive the latest version of the API: currently -``1.3``: +``1.4``: .. code-block:: http @@ -119,7 +119,7 @@ changes breaking your application: .. code-block:: http - GET /api/1.3 HTTP/1.1 + GET /api/1.4 HTTP/1.1 Older API versions will be deprecated and removed over time. For more information, refer to :ref:`rest-api-versions`. @@ -275,6 +275,7 @@ Supported Versions 1.1, 2.1, ✓ 1.2, 2.2, ✓ 1.3, 3.1, ✓ + 1.4, 3.1, ✓ Further information about this and more can typically be found in :doc:`the release notes `. @@ -292,6 +293,7 @@ Auto-generated schema documentation is provided below. /api/rest/schemas/v1.1 /api/rest/schemas/v1.2 /api/rest/schemas/v1.3 + /api/rest/schemas/v1.4 .. Links diff --git a/docs/api/rest/schemas/v1.3.rst b/docs/api/rest/schemas/v1.3.rst index 17a4421ae..c60299a8e 100644 --- a/docs/api/rest/schemas/v1.3.rst +++ b/docs/api/rest/schemas/v1.3.rst @@ -1,4 +1,4 @@ -API v1.3 (latest) +API v1.3 ================= .. openapi:: ../../schemas/v1.3/patchwork.yaml diff --git a/docs/api/rest/schemas/v1.4.rst b/docs/api/rest/schemas/v1.4.rst new file mode 100644 index 000000000..11e34f6a5 --- /dev/null +++ b/docs/api/rest/schemas/v1.4.rst @@ -0,0 +1,5 @@ +API v1.4 (latest) +================= + +.. openapi:: ../../schemas/v1.4/patchwork.yaml + :examples: diff --git a/releasenotes/notes/issue-506-ce13fcdc4523a300.yaml b/releasenotes/notes/issue-506-ce13fcdc4523a300.yaml new file mode 100644 index 000000000..458b5134f --- /dev/null +++ b/releasenotes/notes/issue-506-ce13fcdc4523a300.yaml @@ -0,0 +1,10 @@ +--- +features: + - | + Added support for Series to link to another Series, allowing for automation to link an older version of a series to a newer one. +api: + - | + The API version has been updated to v1.4. + - | + A new REST API endpoint is available at ``/api/series//link/``. + This can be used to link a series to another one