From 2371f2a4cbebdfc161c09f40ec55b1598cae7397 Mon Sep 17 00:00:00 2001
From: Philipp Wolfer <ph.wolfer@gmail.com>
Date: Thu, 11 Jan 2024 12:39:16 +0100
Subject: [PATCH] Subsonic: Added deprecation notice for funkwhaleVersion field

Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2695>
---
 api/funkwhale_api/subsonic/renderers.py                    | 2 ++
 changes/changelog.d/subsonic-funkwhale-version.deprecation | 2 ++
 2 files changed, 4 insertions(+)
 create mode 100644 changes/changelog.d/subsonic-funkwhale-version.deprecation

diff --git a/api/funkwhale_api/subsonic/renderers.py b/api/funkwhale_api/subsonic/renderers.py
index 51efb4206..b715526e0 100644
--- a/api/funkwhale_api/subsonic/renderers.py
+++ b/api/funkwhale_api/subsonic/renderers.py
@@ -35,6 +35,8 @@ ET._serialize_xml = ET._serialize["xml"] = _serialize_xml
 
 def structure_payload(data):
     payload = {
+        # funkwhaleVersion is deprecated and will be removed in a future
+        # release. Use serverVersion instead.
         "funkwhaleVersion": funkwhale_api.__version__,
         "serverVersion": funkwhale_api.__version__,
         "status": "ok",
diff --git a/changes/changelog.d/subsonic-funkwhale-version.deprecation b/changes/changelog.d/subsonic-funkwhale-version.deprecation
new file mode 100644
index 000000000..6db6e360a
--- /dev/null
+++ b/changes/changelog.d/subsonic-funkwhale-version.deprecation
@@ -0,0 +1,2 @@
+The "funkwhaleVersion" field in Subsonic responses is deprecated. Clients
+should use the OpenSubsonic field "serverVersion" instead.