From 137a0db673b4b6375c9cdc16bb3ef88b9970dd6d Mon Sep 17 00:00:00 2001 From: samrth07 Date: Tue, 22 Jul 2025 15:40:07 +0530 Subject: [PATCH 1/3] change routing --- src/routes/projects.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/routes/projects.ts b/src/routes/projects.ts index 242d4fd..c9baf02 100644 --- a/src/routes/projects.ts +++ b/src/routes/projects.ts @@ -35,7 +35,7 @@ export default function projectsRouter( // Get all User /** - * @api {get} /api/v1/projects Get all projects + * @api {get} /api/v1/projects/ Get all projects * @apiName getProjects * @apiGroup Project * @@ -84,7 +84,7 @@ export default function projectsRouter( // Create project /** - * @api {post} /api/v1/projects/create Create a new project + * @api {post} /api/v1/projects/ Create a new project * @apiName createProject * @apiGroup Project * @@ -100,11 +100,11 @@ export default function projectsRouter( * @apiError (500) InternalServerError Database error or internal issue */ - router.post('/create', upload.single('image') , parseCreateProjectData , createProject ) + router.post('/', upload.single('image') , parseCreateProjectData , createProject ) // Update Project /** - * @api {patch} /api/v1/projects/:projectId/update Update a project + * @api {patch} /api/v1/projects/:projectId Update a project * @apiName updateProjects * @apiGroup Project * @@ -121,12 +121,12 @@ export default function projectsRouter( * @apiError (500) InternalServerError Database error or unexpected issue */ - router.patch('/:projectId/update', upload.single('image') , parseCreateProjectData , updateProjects ) + router.patch('/:projectId', upload.single('image') , parseCreateProjectData , updateProjects ) // delete projects /** - * @api {delete} /api/v1/projects/:projectId/delete Delete a project + * @api {delete} /api/v1/projects/:projectId Delete a project * @apiName deleteProjects * @apiGroup Project * @@ -140,7 +140,7 @@ export default function projectsRouter( - router.delete('/:projectId/delete', deleteProjects ) + router.delete('/:projectId', deleteProjects ) /** * @api {get} /api/v1/projects/:projectId/members Get members enrolled in a project From f10f18bfb2f2794f7ea6744bb6a9d8789ea24498 Mon Sep 17 00:00:00 2001 From: samrth07 Date: Tue, 22 Jul 2025 15:50:36 +0530 Subject: [PATCH 2/3] apidoc changes --- src/routes/projects.ts | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/routes/projects.ts b/src/routes/projects.ts index c9baf02..8484916 100644 --- a/src/routes/projects.ts +++ b/src/routes/projects.ts @@ -61,7 +61,7 @@ export default function projectsRouter( * } * ] * - * @apiError (500) InternalServerError Failed to fetch projects from the database + * @apiError (Error 500) InternalServerError Failed to fetch projects from the database */ router.get('/', getProjects) @@ -76,8 +76,8 @@ export default function projectsRouter( * * @apiSuccess {Object} project The project object with the given ID * - * @apiError (404) NotFound No project found with the specified ID - * @apiError (500) InternalServerError Database error or internal issue + * @apiError (Error 404) NotFound No project found with the specified ID + * @apiError (Error 500) InternalServerError Database error or internal issue */ router.get('/:projectId', getProjectById) @@ -96,8 +96,8 @@ export default function projectsRouter( * * @apiSuccess {Object} project The created project object * - * @apiError (400) BadRequest Some fields are missing - * @apiError (500) InternalServerError Database error or internal issue + * @apiError (Error 400) BadRequest Some fields are missing + * @apiError (Error 500) InternalServerError Database error or internal issue */ router.post('/', upload.single('image') , parseCreateProjectData , createProject ) @@ -117,8 +117,8 @@ export default function projectsRouter( * * @apiSuccess {Object} project Updated project data * - * @apiError (400) BadRequest Some required fields are missing or invalid - * @apiError (500) InternalServerError Database error or unexpected issue + * @apiError (Error 400) BadRequest Some required fields are missing or invalid + * @apiError (Error 500) InternalServerError Database error or unexpected issue */ router.patch('/:projectId', upload.single('image') , parseCreateProjectData , updateProjects ) @@ -134,8 +134,8 @@ export default function projectsRouter( * * @apiSuccess {Object} deletedProject Details of the deleted project * - * @apiError (400) BadRequest Some required fields are missing or invalid - * @apiError (500) InternalServerError Internal server error + * @apiError (Error 400) BadRequest Some required fields are missing or invalid + * @apiError (Error 500) InternalServerError Internal server error */ @@ -151,8 +151,8 @@ export default function projectsRouter( * * @apiSuccess {Object[]} members Array of members associated with the project * - * @apiError (400) BadRequest Some required fields are missing - * @apiError (500) InternalServerError Internal server error + * @apiError (Error 400) BadRequest Some required fields are missing + * @apiError (Error 500) InternalServerError Internal server error */ @@ -168,8 +168,8 @@ export default function projectsRouter( * * @apiSuccess {Number} count Number of members successfully added * - * @apiError (400) BadRequest Some required fields are missing - * @apiError (500) InternalServerError Internal server error + * @apiError (Error 400) BadRequest Some required fields are missing + * @apiError (Error 500) InternalServerError Internal server error */ @@ -186,8 +186,8 @@ export default function projectsRouter( * * @apiSuccess {Object} member The member that was removed * - * @apiError (400) BadRequest Some required fields are missing - * @apiError (500) InternalServerError Internal server error + * @apiError (Error 400) BadRequest Some required fields are missing + * @apiError (Error 500) InternalServerError Internal server error */ From f9d1e4a0a9e6df47944528aa84667e5aa08d8c6c Mon Sep 17 00:00:00 2001 From: samrth07 Date: Tue, 22 Jul 2025 16:53:58 +0530 Subject: [PATCH 3/3] changes the routing in annoation --- src/routes/projects.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/routes/projects.ts b/src/routes/projects.ts index 8484916..3336f1d 100644 --- a/src/routes/projects.ts +++ b/src/routes/projects.ts @@ -35,7 +35,7 @@ export default function projectsRouter( // Get all User /** - * @api {get} /api/v1/projects/ Get all projects + * @api {get} /projects/ Get all projects * @apiName getProjects * @apiGroup Project * @@ -68,7 +68,7 @@ export default function projectsRouter( // get Project by Id /** - * @api {get} /api/v1/projects/:projectId Get specific project by ID + * @api {get} /projects/:projectId Get specific project by ID * @apiName getProjectById * @apiGroup Project * @@ -84,7 +84,7 @@ export default function projectsRouter( // Create project /** - * @api {post} /api/v1/projects/ Create a new project + * @api {post} /projects/ Create a new project * @apiName createProject * @apiGroup Project * @@ -104,7 +104,7 @@ export default function projectsRouter( // Update Project /** - * @api {patch} /api/v1/projects/:projectId Update a project + * @api {patch} /projects/:projectId Update a project * @apiName updateProjects * @apiGroup Project * @@ -126,7 +126,7 @@ export default function projectsRouter( // delete projects /** - * @api {delete} /api/v1/projects/:projectId Delete a project + * @api {delete} /projects/:projectId Delete a project * @apiName deleteProjects * @apiGroup Project * @@ -143,7 +143,7 @@ export default function projectsRouter( router.delete('/:projectId', deleteProjects ) /** - * @api {get} /api/v1/projects/:projectId/members Get members enrolled in a project + * @api {get} /projects/:projectId/members Get members enrolled in a project * @apiName getMembersByProjectId * @apiGroup MemberProject * @@ -159,7 +159,7 @@ export default function projectsRouter( router.get('/:projectId/members', getMembersByProjectId ) /** - * @api {post} /api/v1/projects/:projectId/members Add members to a project + * @api {post} /projects/:projectId/members Add members to a project * @apiName addMembers * @apiGroup MemberProject * @@ -177,7 +177,7 @@ export default function projectsRouter( // Remover the memnber /** - * @api {delete} /api/v1/projects/:projectId/members/:memberId Remove a member from a project + * @api {delete} /projects/:projectId/members/:memberId Remove a member from a project * @apiName removeMember * @apiGroup MemberProject *