diff --git a/ArchiSteamFarm/IPC/Controllers/Api/ASFController.cs b/ArchiSteamFarm/IPC/Controllers/Api/ASFController.cs index 0ef09f52d..a69e6abae 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/ASFController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/ASFController.cs @@ -41,7 +41,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Fetches common info related to ASF as a whole. /// [HttpGet] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public ActionResult> ASFGet() { uint memoryUsage = (uint) GC.GetTotalMemory(false) / 1024; @@ -60,7 +60,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// [Consumes("application/json")] [HttpPost] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> ASFPost([FromBody] ASFRequest request) { if (request == null) { ASF.ArchiLogger.LogNullError(nameof(request)); @@ -88,7 +88,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Makes ASF shutdown itself. /// [HttpPost("Exit")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public ActionResult ExitPost() { (bool success, string output) = Actions.Exit(); return Ok(new GenericResponse(success, output)); @@ -98,7 +98,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Makes ASF restart itself. /// [HttpPost("Restart")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public ActionResult RestartPost() { (bool success, string output) = Actions.Restart(); return Ok(new GenericResponse(success, output)); @@ -108,7 +108,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Makes ASF update itself. /// [HttpPost("Update")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task>> UpdatePost() { (bool success, Version version) = await Actions.Update().ConfigureAwait(false); return Ok(new GenericResponse(success, version)); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/BotController.cs b/ArchiSteamFarm/IPC/Controllers/Api/BotController.cs index 825717cc6..bae64217c 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/BotController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/BotController.cs @@ -43,7 +43,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Deletes all files related to given bots. /// [HttpDelete("{botNames:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> BotDelete(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -63,7 +63,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Fetches common info related to given bots. /// [HttpGet("{botNames:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse>))] + [ProducesResponseType(typeof(GenericResponse>), 200)] public ActionResult>> BotGet(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -83,7 +83,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// [Consumes("application/json")] [HttpPost("{botName:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> BotPost(string botName, [FromBody] BotRequest request) { if (string.IsNullOrEmpty(botName) || (request == null)) { ASF.ArchiLogger.LogNullError(nameof(botName) + " || " + nameof(request)); @@ -121,7 +121,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Removes BGR output files of given bots. /// [HttpDelete("{botNames:required}/GamesToRedeemInBackground")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> GamesToRedeemInBackgroundDelete(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -141,7 +141,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Fetches BGR output files of given bots. /// [HttpGet("{botNames:required}/GamesToRedeemInBackground")] - [SwaggerResponse(200, type: typeof(GenericResponse>))] + [ProducesResponseType(typeof(GenericResponse>), 200)] public async Task>>> GamesToRedeemInBackgroundGet(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -170,7 +170,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// [Consumes("application/json")] [HttpPost("{botName:required}/GamesToRedeemInBackground")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task>> GamesToRedeemInBackgroundPost(string botName, [FromBody] GamesToRedeemInBackgroundRequest request) { if (string.IsNullOrEmpty(botName) || (request == null)) { ASF.ArchiLogger.LogNullError(nameof(botName) + " || " + nameof(request)); @@ -194,7 +194,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// [Consumes("application/json")] [HttpPost("{botNames:required}/Pause")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> PausePost(string botNames, [FromBody] BotPauseRequest request) { if (string.IsNullOrEmpty(botNames) || (request == null)) { ASF.ArchiLogger.LogNullError(nameof(botNames) + " || " + nameof(request)); @@ -214,7 +214,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Resumes given bots. /// [HttpPost("{botNames:required}/Resume")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> ResumePost(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -234,7 +234,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Starts given bots. /// [HttpPost("{botNames:required}/Start")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> StartPost(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); @@ -254,7 +254,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Stops given bots. /// [HttpPost("{botNames:required}/Stop")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task> StopPost(string botNames) { if (string.IsNullOrEmpty(botNames)) { ASF.ArchiLogger.LogNullError(nameof(botNames)); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/CommandController.cs b/ArchiSteamFarm/IPC/Controllers/Api/CommandController.cs index 273423c5a..400db3176 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/CommandController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/CommandController.cs @@ -43,7 +43,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// You should use "given bot" commands when executing this endpoint, omitting targets of the command will cause the command to be executed on first defined bot /// [HttpPost("{command:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task>> CommandPost(string command) { if (string.IsNullOrEmpty(command)) { ASF.ArchiLogger.LogNullError(nameof(command)); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/NLogController.cs b/ArchiSteamFarm/IPC/Controllers/Api/NLogController.cs index 64c5f877d..388aea0ae 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/NLogController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/NLogController.cs @@ -50,7 +50,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// This API endpoint requires a websocket connection. /// [HttpGet] - [SwaggerResponse(200, type: typeof(IEnumerable>))] + [ProducesResponseType(typeof(IEnumerable>), 200)] public async Task NLogGet() { if (!HttpContext.WebSockets.IsWebSocketRequest) { return BadRequest(new GenericResponse(false, string.Format(Strings.WarningFailedWithError, nameof(HttpContext.WebSockets.IsWebSocketRequest) + ": " + HttpContext.WebSockets.IsWebSocketRequest))); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/StructureController.cs b/ArchiSteamFarm/IPC/Controllers/Api/StructureController.cs index 2e335df6c..b5b485d68 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/StructureController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/StructureController.cs @@ -40,7 +40,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Structure is defined as a representation of given object in its default state. /// [HttpGet("{structure:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public ActionResult> StructureGet(string structure) { if (string.IsNullOrEmpty(structure)) { ASF.ArchiLogger.LogNullError(nameof(structure)); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/TypeController.cs b/ArchiSteamFarm/IPC/Controllers/Api/TypeController.cs index 52101c879..65ac8fb06 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/TypeController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/TypeController.cs @@ -44,7 +44,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// Type info is defined as a representation of given object with its fields and properties being assigned to a string value that defines their type. /// [HttpGet("{type:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public ActionResult> TypeGet(string type) { if (string.IsNullOrEmpty(type)) { ASF.ArchiLogger.LogNullError(nameof(type)); diff --git a/ArchiSteamFarm/IPC/Controllers/Api/WWWController.cs b/ArchiSteamFarm/IPC/Controllers/Api/WWWController.cs index a6a71c724..259029713 100644 --- a/ArchiSteamFarm/IPC/Controllers/Api/WWWController.cs +++ b/ArchiSteamFarm/IPC/Controllers/Api/WWWController.cs @@ -45,7 +45,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// This is internal API being utilizied by our ASF-ui IPC frontend. You should not depend on existence of any /Api/WWW as they can disappear and change anytime. /// [HttpGet("Directory/{directory:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse>))] + [ProducesResponseType(typeof(GenericResponse>), 200)] public ActionResult>> DirectoryGet(string directory) { if (string.IsNullOrEmpty(directory)) { ASF.ArchiLogger.LogNullError(nameof(directory)); @@ -76,7 +76,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// This is internal API being utilizied by our ASF-ui IPC frontend. You should not depend on existence of any /Api/WWW as they can disappear and change anytime. /// [HttpGet("GitHub/Releases")] - [SwaggerResponse(200, type: typeof(GenericResponse>))] + [ProducesResponseType(typeof(GenericResponse>), 200)] public async Task>>> GitHubReleasesGet([FromQuery] byte count = 10) { if (count == 0) { return BadRequest(new GenericResponse>(false, string.Format(Strings.ErrorIsEmpty, nameof(count)))); @@ -98,7 +98,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// This is internal API being utilizied by our ASF-ui IPC frontend. You should not depend on existence of any /Api/WWW as they can disappear and change anytime. /// [HttpGet("GitHub/Releases/{version:required}")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task>> GitHubReleasesGet(string version) { if (string.IsNullOrEmpty(version)) { return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(version)))); @@ -120,7 +120,7 @@ namespace ArchiSteamFarm.IPC.Controllers.Api { /// [Consumes("application/json")] [HttpPost("Send")] - [SwaggerResponse(200, type: typeof(GenericResponse))] + [ProducesResponseType(typeof(GenericResponse), 200)] public async Task>> SendPost([FromBody] WWWSendRequest request) { if (request == null) { ASF.ArchiLogger.LogNullError(nameof(request));