From ed1343857fcbfb97b6c55b48c3c679ff1f28ac1a Mon Sep 17 00:00:00 2001
From: "Matthew D. Groves" <me@mgroves.com>
Date: Tue, 26 Sep 2023 10:35:06 -0400
Subject: [PATCH] #21 comment docs

---
 .../Articles/Controllers/CommentsController.cs      | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs b/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs
index 09106cd08f..73604637e8 100644
--- a/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs
+++ b/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs
@@ -79,6 +79,9 @@ public async Task<IActionResult> AddComment([FromRoute] string slug, [FromBody]
     /// </remarks>
     /// <param name="slug">Article slug (required)</param>
     /// <returns>Comments array</returns>
+    /// <response code="200">Successfully retrieved comments</response>
+    /// <response code="404">Article wasn't found</response>
+    /// <response code="500">Something went wrong while deleting the comment</response>
     [HttpGet]
     [AllowAnonymous]
     [Route("/api/articles/{slug}/comments")]
@@ -107,6 +110,16 @@ public async Task<IActionResult> GetComments([FromRoute] string slug)
         return Ok(new { comments = response.CommentsView });
     }
 
+    /// <summary>
+    /// Delete a comment from an article
+    /// </summary>
+    /// <param name="slug">Article slug (required)</param>
+    /// <param name="commentId">Comment ID (required)</param>
+    /// <response code="200">Successfully deleted</response>
+    /// <response code="401">Unauthorized, likely because credentials are incorrect or its not your comment</response>
+    /// <response code="404">Article or comment wasn't found</response>
+    /// <response code="422">Comment couldn't be deleted</response>
+    /// <response code="500">Something went wrong while deleting the comment</response>
     [HttpDelete]
     [Route("/api/articles/{slug}/comments/{commentId}")]
     [Authorize]