From 776632e492c4d1d7c90da2e55d4bea8bf237f82b Mon Sep 17 00:00:00 2001 From: Valeri91515-lang Date: Wed, 24 Jun 2026 12:41:34 -0400 Subject: [PATCH 1/2] feat: add JSDoc documentation to userService routes Adds concise JSDoc comments to user GET and POST route handlers, including route path, description, parameter types, and return values. Closes #1 --- apps/api/src/routes/users.ts | 25 ++++++++++++++++++++++--- contributors/agents.json | 14 +++++++++++--- 2 files changed, 33 insertions(+), 6 deletions(-) diff --git a/apps/api/src/routes/users.ts b/apps/api/src/routes/users.ts index 8d7f6d2ee4..818dfb8d0a 100644 --- a/apps/api/src/routes/users.ts +++ b/apps/api/src/routes/users.ts @@ -1,15 +1,34 @@ -import { Router } from "express"; +import { Router, Request, Response } from "express"; const router = Router(); -router.get("/", (_req, res) => { +/** + * GET /users + * + * Retrieve a list of all users. + * Currently returns a stub response — implementation pending. + * + * @route GET /users + * @returns {Object} JSON response with an empty data array and status message. + */ +router.get("/", (_req: Request, res: Response) => { res.json({ data: [], message: "User listing is not implemented yet." }); }); -router.post("/", (req, res) => { +/** + * POST /users + * + * Create a new user. + * Currently returns a stub response with a placeholder ID — implementation pending. + * + * @route POST /users + * @param {Request} req - Express request object containing user data in body. + * @returns {Object} JSON response with the created stub user data. + */ +router.post("/", (req: Request, res: Response) => { res.status(201).json({ data: { id: "stub-user-id", diff --git a/contributors/agents.json b/contributors/agents.json index a3fbd7156d..dda7923870 100644 --- a/contributors/agents.json +++ b/contributors/agents.json @@ -1,5 +1,13 @@ { - "agents": [], - "last_updated": "2026-06-03", - "total_contributions": 0 + "agents": [ + { + "name": "Hermes Agent (Aria)", + "model": "deepseek-v4-flash-free", + "provider": "opencode-zen", + "contributed_at": "2026-06-24", + "notes": "Added JSDoc to userService routes" + } + ], + "last_updated": "2026-06-24", + "total_contributions": 1 } From 7ea941cc1cabd113c2f37aa98d9e4b85204b3bd9 Mon Sep 17 00:00:00 2001 From: Valeri91515-lang Date: Thu, 25 Jun 2026 13:07:24 -0400 Subject: [PATCH 2/2] chore: register AI agent in contributors/agents.json --- contributors/agents.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/contributors/agents.json b/contributors/agents.json index dda7923870..20876089b6 100644 --- a/contributors/agents.json +++ b/contributors/agents.json @@ -6,8 +6,15 @@ "provider": "opencode-zen", "contributed_at": "2026-06-24", "notes": "Added JSDoc to userService routes" + }, + { + "github_username": "Valeri91515-lang", + "model": "deepseek-v4-flash-free (via Hermes Agent)", + "version": "1.0", + "pr_number": 2137, + "issue_number": 1 } ], - "last_updated": "2026-06-24", - "total_contributions": 1 + "last_updated": "2026-06-25", + "total_contributions": 2 }