From d5937117c6fa9d5c57a4e71272f39f904c2357e9 Mon Sep 17 00:00:00 2001
From: Cucumberrbob <128094686+Cucumberrbob@users.noreply.github.com>
Date: Sun, 23 Mar 2025 13:50:25 +0000
Subject: [PATCH] add openapi docs for new `GET /Api/Settings/Version` endpoint

---
 .../Controllers/SettingsController.cs         | 20 +++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/server/RdtClient.Web/Controllers/SettingsController.cs b/server/RdtClient.Web/Controllers/SettingsController.cs
index 1498ebd..f1cf08f 100644
--- a/server/RdtClient.Web/Controllers/SettingsController.cs
+++ b/server/RdtClient.Web/Controllers/SettingsController.cs
@@ -71,15 +71,19 @@ public class SettingsController(Settings settings, Torrents torrents) : Controll
         return Ok(profile);
     }
 
+    /// <summary>
+    /// Gets the version of rdt-client the server is running
+    /// </summary>
+    /// <returns>The Version Number</returns>
     [HttpGet]
     [Route("Version")]
     public ActionResult<Version> Version()
     {
         var version = Assembly.GetExecutingAssembly().GetName().Version!;
 
-        return Ok(new
+        return Ok(new SettingsControllerVersionResponse
         {
-            Version = version
+            Version = version.ToString()
         });
     }
 
@@ -318,4 +322,16 @@ public class SettingsControllerTestAria2cConnectionRequest
     /// <example>your-secret-token</example>
     [Required] 
     public String? Secret { get; set; }
+}
+
+/// <summary>
+/// Response model for the version information
+/// </summary>
+public class SettingsControllerVersionResponse
+{
+    /// <summary>
+    /// The version number
+    /// </summary>
+    /// <example>v2.0.102</example>
+    public required String? Version { get; set; }
 }
\ No newline at end of file