feat(api): add deprecation headers to releng legacy JSON endpoint

Add `deprecated_json_endpoint` decorator in `api/deprecation.py` (RFC 8594).
Apply to `releng/views.py` `releases_json` - response now includes
`Deprecation: true` and `Link: </api/v1/releng/releases/>; rel="successor-version"`.

Author: inglor

api/deprecation.py

@@ -0,0 +1,13 @@
+from functools import wraps
+
+
+def deprecated_json_endpoint(successor_path: str):
+    def decorator(view_func):
+        @wraps(view_func)
+        def wrapper(request, *args, **kwargs):
+            response = view_func(request, *args, **kwargs)
+            response['Deprecation'] = 'true'
+            response['Link'] = f'<{successor_path}>; rel="successor-version"'
+            return response
+        return wrapper
+    return decorator

api/schemas/releng.py

@@ -1,29 +1,28 @@
 from datetime import date, datetime
-from typing import Optional
 
 from ninja import Schema
 
 
 class ReleaseSchema(Schema):
     version: str
-    kernel_version: Optional[str] = None
+    kernel_version: str | None = None
     release_date: date
     available: bool
     info: str
-    iso_url: Optional[str] = None
-    magnet_uri: Optional[str] = None
-    torrent_url: Optional[str] = None
-    md5_sum: Optional[str] = None
-    sha1_sum: Optional[str] = None
-    sha256_sum: Optional[str] = None
-    b2_sum: Optional[str] = None
-    wkd_email: Optional[str] = None
-    pgp_fingerprint: Optional[str] = None
+    iso_url: str | None = None
+    magnet_uri: str | None = None
+    torrent_url: str | None = None
+    md5_sum: str | None = None
+    sha1_sum: str | None = None
+    sha256_sum: str | None = None
+    b2_sum: str | None = None
+    wkd_email: str | None = None
+    pgp_fingerprint: str | None = None
     created: datetime
     last_modified: datetime
 
 
 class ReleasesSchema(Schema):
     version: int
     releases: list[ReleaseSchema]
-    latest_version: Optional[str] = None
+    latest_version: str | None = None

api/tests/test_deprecation.py

@@ -0,0 +1,5 @@
+def test_releng_releases_json_deprecation_headers(db, client):
+    response = client.get('/releng/releases/json/')
+    assert response.status_code == 200
+    assert response['Deprecation'] == 'true'
+    assert response['Link'] == '</api/v1/releng/releases/>; rel="successor-version"'

releng/views.py

@@ -8,6 +8,7 @@
 from django.urls import reverse
 from django.views.generic import DetailView, ListView
 
+from api.deprecation import deprecated_json_endpoint
 from main.models import Package
 from mirrors.models import MirrorUrl
 
@@ -59,6 +60,7 @@ def default(self, obj):
         return super().default(obj)
 
 
+@deprecated_json_endpoint('/api/v1/releng/releases/')
 def releases_json(request):
     releases = Release.objects.all()
     try: