#19 updated docs for add comment

mgroves · Sep 22, 2023 · 63f2bfc · 63f2bfc
1 parent 1a3a10d
commit 63f2bfc
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/Conduit/Conduit.Migrations/008_CreateCollectionForComments.cs b/Conduit/Conduit.Migrations/008_CreateCollectionForComments.cs
@@ -2,7 +2,7 @@
 
 namespace Conduit.Migrations;
 
-// Manual alternative: create a Favorites collection in _default scope
+// Manual alternative: create a Comments collection in _default scope
 [Migration(8)]
 public class CreateCollectionForComments: MigrateBase
 {

diff --git a/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs b/Conduit/Conduit.Web/Articles/Controllers/CommentsController.cs
@@ -22,15 +22,29 @@ public CommentsController(IAuthService authService, IMediator mediator)
         _mediator = mediator;
     }
 
+    /// <summary>
+    /// Add comment to an article
+    /// </summary>
+    /// <remarks>
+    /// <a href="https://realworld-docs.netlify.app/docs/specs/backend-specs/endpoints#add-comments-to-an-article">Conduit spec for Add Comments to an Article</a>
+    /// </remarks>
+    /// <param name="slug">Article slug</param>
+    /// <param name="comment">Body of the comment</param>
+    /// <returns>A view of the created comment</returns>
+    /// <response code="200">Successful created, returns the created Comment</response>
+    /// <response code="401">Unauthorized, likely because credentials are incorrect</response>
+    /// <response code="404">Article wasn't found</response>
+    /// <response code="422">Article was unable to be created</response>
+    /// <response code="500">Something went wrong while creating the article</response>
     [HttpPost]
     [Route("/api/articles/{slug}/comments")]
     [Authorize]
-    public async Task<IActionResult> AddComment([FromRoute] string slug, [FromBody] CommentBodyModel body)
+    public async Task<IActionResult> AddComment([FromRoute] string slug, [FromBody] CommentBodyModel comment)
     {
         var claims = _authService.GetAllAuthInfo(Request.Headers["Authorization"]);
         var username  = claims.Username.Value;
 
-        var addCommentRequest = new AddCommentRequest(username, body, slug);
+        var addCommentRequest = new AddCommentRequest(username, comment, slug);
         var addCommentResponse = await _mediator.Send(addCommentRequest);
 
         if (addCommentResponse.ValidationErrors?.Any() ?? false)

diff --git a/Conduit/Conduit.Web/Articles/ViewModels/CommentBodyModel.cs b/Conduit/Conduit.Web/Articles/ViewModels/CommentBodyModel.cs
@@ -7,5 +7,8 @@ public class CommentBodyModel
 
 public class CommentBody
 {
+    /// <summary>
+    /// Body of the comment, required, must be less than 1000 characters
+    /// </summary>
     public string Body { get; set; }
 }