From d53b85fe9e18f3a4780813ff8f8bcb99465cbba1 Mon Sep 17 00:00:00 2001 From: eee4 <41441600+eee4@users.noreply.github.com> Date: Fri, 18 Jul 2025 13:38:55 +0200 Subject: [PATCH] chore: tiny documentation changes --- Controllers/CategoryController.cs | 4 +++- Controllers/QuoteController.cs | 11 ++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Controllers/CategoryController.cs b/Controllers/CategoryController.cs index ae1f520..552b3e8 100644 --- a/Controllers/CategoryController.cs +++ b/Controllers/CategoryController.cs @@ -72,7 +72,9 @@ public class CategoryController : ControllerBase /// /// /// Allows authorized users to create categories.
- /// Important! Category names are case insensitive.
+ /// Important! + ///

+ /// Category names are case insensitive.
/// Has CORS set. ///
/// Returned on valid request diff --git a/Controllers/QuoteController.cs b/Controllers/QuoteController.cs index d743572..bd869db 100644 --- a/Controllers/QuoteController.cs +++ b/Controllers/QuoteController.cs @@ -35,13 +35,15 @@ public class QuotesController : ControllerBase /// /// /// A page of quotes consists of 10 quotes or less. - /// If a page does not contain any quotes, 404 is returned. - /// Important! Has CORS set, unlike e.g. GET /api/v1/quote/{id} or GET /api/v1/quote/random. + /// If a page does not contain any quotes, an empty list is returned. + ///

+ /// Important! + /// Has CORS set, unlike e.g. GET /api/v1/quote/{id} or GET /api/v1/quote/random. ///
/// The page number /// A page (10 quotes) /// Returned on valid request - /// Returned when requested page is invalid + /// Returned when requested page is invalid (page_no <= 0) [HttpGet("page/{page_no}")] [EnableCors] [ProducesResponseType(typeof(List), 200)] @@ -77,6 +79,9 @@ public class QuotesController : ControllerBase /// /// [AUTHED] Get specified quote summary /// + /// + /// As per project's guidelines, requires a JWT. + /// /// The quote id in question /// A quote: id, quote content and author, imageUrl and categories if successful, otherwise: error message /// Returned on valid request