add openapi docs for new GET /Api/Settings/Version endpoint

This commit is contained in:
Cucumberrbob 2025-03-23 13:50:25 +00:00
parent 327100b249
commit d5937117c6
No known key found for this signature in database
GPG key ID: 2B935C47401C3614

View file

@ -71,15 +71,19 @@ public class SettingsController(Settings settings, Torrents torrents) : Controll
return Ok(profile); return Ok(profile);
} }
/// <summary>
/// Gets the version of rdt-client the server is running
/// </summary>
/// <returns>The Version Number</returns>
[HttpGet] [HttpGet]
[Route("Version")] [Route("Version")]
public ActionResult<Version> Version() public ActionResult<Version> Version()
{ {
var version = Assembly.GetExecutingAssembly().GetName().Version!; var version = Assembly.GetExecutingAssembly().GetName().Version!;
return Ok(new return Ok(new SettingsControllerVersionResponse
{ {
Version = version Version = version.ToString()
}); });
} }
@ -319,3 +323,15 @@ public class SettingsControllerTestAria2cConnectionRequest
[Required] [Required]
public String? Secret { get; set; } 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; }
}