docs: add note to link shortening endpoint swagger doc

2026-01-07 23:04:35 +01:00
parent 355338e397
commit 109f22c231
1 changed files with 4 additions and 2 deletions
--- a/src/routes/linkRoutes.ts
+++ b/src/routes/linkRoutes.ts
@@ -104,9 +104,11 @@ linkRouter.get('/api/v1/link/fromWordlist', validateSchema(ls.sentenceLinkReques
 *   post:
 *     description:
 *       Register a new shortened URL. <br/>
- *       See linkSchema.ts for constraints.
+ *       See linkSchema.ts for constraints. <br/>
+ *       <b>Note:</b> This endpoint's functionality differs depending on the user info,
+ *       which means guests will be treated differently from authenticated users.
 *     tags: [Link]
- *     summary: Shorten a link
+ *     summary: "[AUTHED?] Shorten a link"
 *     requestBody:
 *       required: true
 *       content: