From 23d16dd676764c82fc51b4387cd0c8647f190a42 Mon Sep 17 00:00:00 2001
From: exsersewo <exsersewo@systemexit.co.uk>
Date: Mon, 16 Jan 2023 18:27:52 +0000
Subject: [PATCH] add some documentation to swagger about return types & fix
 get templates not returning

---
 src/.idea/.idea.Kynareth/.idea/vcs.xml         |  1 -
 src/Controllers/ImageGenerationController.cs   |  8 +++++++-
 src/Controllers/ImageManipulationController.cs | 12 ++++++++++--
 3 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/src/.idea/.idea.Kynareth/.idea/vcs.xml b/src/.idea/.idea.Kynareth/.idea/vcs.xml
index 64713b8..6c0b863 100644
--- a/src/.idea/.idea.Kynareth/.idea/vcs.xml
+++ b/src/.idea/.idea.Kynareth/.idea/vcs.xml
@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
     <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
   </component>
 </project>
\ No newline at end of file
diff --git a/src/Controllers/ImageGenerationController.cs b/src/Controllers/ImageGenerationController.cs
index 0ce57f6..2d24861 100644
--- a/src/Controllers/ImageGenerationController.cs
+++ b/src/Controllers/ImageGenerationController.cs
@@ -17,15 +17,21 @@ public class ImageGenerationController : BaseController<ImageGenerationControlle
 
 	[HttpGet]
 	[EndpointMetrics("image.generate.get.templates")]
+	[ProducesResponseType(typeof(IEnumerable<ImageGenerationEndpointRead>), StatusCodes.Status200OK)]
 	public Task<object> GetTemplates()
 	{
 		string serialized = JsonSerializer.Serialize(ImageManager.GetGenerationEndpoints());
 			
-		return Task.FromResult(HttpContext.Send(EventResult.FromSuccess()));
+		return Task.FromResult(HttpContext.Send(EventResult.FromSuccess(serialized)));
 	}
 		
 	[HttpGet("{template}")]
 	[EndpointMetrics("image.generate.generate")]
+	[ProducesResponseType(typeof(Stream), StatusCodes.Status200OK, "image/png")]
+	[ProducesResponseType(typeof(Stream), StatusCodes.Status200OK, "image/gif")]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status400BadRequest)]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status404NotFound)]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status500InternalServerError)]
 	public async Task<object> GetImageAsync(string template, [FromQuery(Name = "source")] string[] sources, [FromQuery] string variant = null)
 	{
 		try
diff --git a/src/Controllers/ImageManipulationController.cs b/src/Controllers/ImageManipulationController.cs
index b1bf0cc..23b753a 100644
--- a/src/Controllers/ImageManipulationController.cs
+++ b/src/Controllers/ImageManipulationController.cs
@@ -18,6 +18,10 @@ public class ImageManipulationController : BaseController<ImageManipulationContr
 	/// ---------- ///
 	[HttpGet("magik")]
 	[EndpointMetrics("image.manipulation.magik")]
+	[ProducesResponseType(typeof(Stream), StatusCodes.Status200OK, "image/png")]
+	[ProducesResponseType(typeof(Stream), StatusCodes.Status200OK, "image/gif")]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status400BadRequest)]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status500InternalServerError)]
 	public async Task<object> MagikImage([FromQuery] string image)
 	{
 		try
@@ -29,7 +33,7 @@ public class ImageManipulationController : BaseController<ImageManipulationContr
 				return HttpContext.SendStream(data, contentType);
 			}
 
-			return HttpContext.Send(EventResult.FromFailure("No image has been provided"), System.Net.HttpStatusCode.InternalServerError);
+			return HttpContext.Send(EventResult.FromFailure("No image has been provided"), System.Net.HttpStatusCode.BadRequest);
 		}
 		catch (ArgumentException ex)
 		{
@@ -46,6 +50,10 @@ public class ImageManipulationController : BaseController<ImageManipulationContr
 	/// ------------- ///
 	[HttpGet("{template}")]
 	[EndpointMetrics("image.manipulation.generate")]
+	[ProducesResponseType(typeof(Stream), StatusCodes.Status200OK, "image/png")]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status400BadRequest)]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status404NotFound)]
+	[ProducesResponseType(typeof(EventResult), StatusCodes.Status500InternalServerError)]
 	public async Task<object> GenerateMemeAsync(string template, [FromQuery] string[] text)
 	{
 		try
@@ -64,7 +72,7 @@ public class ImageManipulationController : BaseController<ImageManipulationContr
 				return result as IResult;
 			}
 
-			return HttpContext.Send(EventResult.FromFailure("No template has been provided"), System.Net.HttpStatusCode.InternalServerError);
+			return HttpContext.Send(EventResult.FromFailure("No template has been provided"), System.Net.HttpStatusCode.BadRequest);
 		}
 		catch (ArgumentException ex)
 		{