chore: documentation and formatting for random quote and deleting categories

Controllers/CategoryController.cs

@@ -108,48 +108,55 @@ public class CategoryController : ControllerBase
         // And send back to the user as DTO
         return Ok(cat.ToCategoryShortDTO());
 
-    }
-
-    [HttpDelete("{id}")]
-    [Authorize]
-    [EnableCors]
-    [ProducesResponseType(200)]
-    [ProducesResponseType(typeof(ErrorDTO), 404)]
-    public async Task<IActionResult> DeleteCategory(int id)
-    {
-        // (Attempt to) find the quote
-        Category? cat = await _db.Categories
-                            .FirstOrDefaultAsync(c => c.Id == id);
-        // Failed?
-        if (cat == null)
-            return NotFound(new { status = "error", error_msg = "Quote not found" });
-
-        List<QuoteCategory> quoteLinks = await _db.QuoteCategories.Where(qc => qc.CategoryId == id).ToListAsync();
-
-
-
-        foreach (var link in quoteLinks) {
-            _db.QuoteCategories.Remove(link);
-        }
-        _db.Categories.Remove(cat);
-
-        await _db.SaveChangesAsync();
-
-        // ====================================================================== //
-        // Important!                                                             //
-        // Is this the best we can do? Won't marking the quote as "hidden"        //
-        // be better than explicitly deleting it? ~eee4                           //
-        // ====================================================================== //
-
-        // Return ok
-        return Ok(new { Status = "ok" });
+    }
+
+    // DELETE /api/v1/categories
+    /// <summary>
+    /// [AUTHED] Delete a category
+    /// </summary>
+    /// <remarks>
+    /// Allows authorized users to delete categories.
+    /// <br/><br/>
+    /// Has CORS set.
+    /// </remarks>
+    /// <param name="id">Id of the category which shall be deleted</param>
+    /// <response code="200">Returned on valid request</response>
+    /// <response code="404">Returned when no such category exists</response>
+    [HttpDelete("{id}")]
+    [Authorize]
+    [EnableCors]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(typeof(ErrorDTO), 404)]
+    public async Task<IActionResult> DeleteCategory(int id)
+    {
+        // (Attempt to) find the category
+        Category? cat = await _db.Categories
+                            .FirstOrDefaultAsync(c => c.Id == id);
+        // Failed?
+        if (cat == null)
+            return NotFound(new { status = "error", error_msg = "Category not found" });
+
+        // Find all the QuoteId <-> CategoryId pairs for provided id
+        List<QuoteCategory> quoteLinks = await _db.QuoteCategories
+                                                .Where(qc => qc.CategoryId == id)
+                                                .ToListAsync();
+
+        // For each of the dependent quotes
+        foreach (var link in quoteLinks) {
+            // Remove all the associative pairs
+            _db.QuoteCategories.Remove(link);
+        }
+
+        // Finally, remove the category
+        _db.Categories.Remove(cat);
+        await _db.SaveChangesAsync();
+
+        // Return ok
+        return Ok(new { Status = "ok" });
     }
 
     // TODO: Update category
     // PATCH /api/v1/categories/1
 
-    // TODO: Delete category
-    // DELETE /api/v1/categories/1
-
 }
-
+