Skip to content

Commit 3e8061d

Browse files
Merge pull request #14 from call-0f-code/Fix-routes
change routing
2 parents d9f9fbb + f9d1e4a commit 3e8061d

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

src/routes/projects.ts

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export default function projectsRouter(
3535

3636
// Get all User
3737
/**
38-
* @api {get} /api/v1/projects Get all projects
38+
* @api {get} /projects/ Get all projects
3939
* @apiName getProjects
4040
* @apiGroup Project
4141
*
@@ -61,30 +61,30 @@ export default function projectsRouter(
6161
* }
6262
* ]
6363
*
64-
* @apiError (500) InternalServerError Failed to fetch projects from the database
64+
* @apiError (Error 500) InternalServerError Failed to fetch projects from the database
6565
*/
6666

6767
router.get('/', getProjects)
6868

6969
// get Project by Id
7070
/**
71-
* @api {get} /api/v1/projects/:projectId Get specific project by ID
71+
* @api {get} /projects/:projectId Get specific project by ID
7272
* @apiName getProjectById
7373
* @apiGroup Project
7474
*
7575
* @apiParam (Path) {UUID} projectId ID of the project
7676
*
7777
* @apiSuccess {Object} project The project object with the given ID
7878
*
79-
* @apiError (404) NotFound No project found with the specified ID
80-
* @apiError (500) InternalServerError Database error or internal issue
79+
* @apiError (Error 404) NotFound No project found with the specified ID
80+
* @apiError (Error 500) InternalServerError Database error or internal issue
8181
*/
8282

8383
router.get('/:projectId', getProjectById)
8484

8585
// Create project
8686
/**
87-
* @api {post} /api/v1/projects/create Create a new project
87+
* @api {post} /projects/ Create a new project
8888
* @apiName createProject
8989
* @apiGroup Project
9090
*
@@ -96,15 +96,15 @@ export default function projectsRouter(
9696
*
9797
* @apiSuccess {Object} project The created project object
9898
*
99-
* @apiError (400) BadRequest Some fields are missing
100-
* @apiError (500) InternalServerError Database error or internal issue
99+
* @apiError (Error 400) BadRequest Some fields are missing
100+
* @apiError (Error 500) InternalServerError Database error or internal issue
101101
*/
102102

103-
router.post('/create', upload.single('image') , parseCreateProjectData , createProject )
103+
router.post('/', upload.single('image') , parseCreateProjectData , createProject )
104104

105105
// Update Project
106106
/**
107-
* @api {patch} /api/v1/projects/:projectId/update Update a project
107+
* @api {patch} /projects/:projectId Update a project
108108
* @apiName updateProjects
109109
* @apiGroup Project
110110
*
@@ -117,49 +117,49 @@ export default function projectsRouter(
117117
*
118118
* @apiSuccess {Object} project Updated project data
119119
*
120-
* @apiError (400) BadRequest Some required fields are missing or invalid
121-
* @apiError (500) InternalServerError Database error or unexpected issue
120+
* @apiError (Error 400) BadRequest Some required fields are missing or invalid
121+
* @apiError (Error 500) InternalServerError Database error or unexpected issue
122122
*/
123123

124-
router.patch('/:projectId/update', upload.single('image') , parseCreateProjectData , updateProjects )
124+
router.patch('/:projectId', upload.single('image') , parseCreateProjectData , updateProjects )
125125

126126
// delete projects
127127

128128
/**
129-
* @api {delete} /api/v1/projects/:projectId/delete Delete a project
129+
* @api {delete} /projects/:projectId Delete a project
130130
* @apiName deleteProjects
131131
* @apiGroup Project
132132
*
133133
* @apiParam (Path Params) {Number} projectId ID of the project to be deleted
134134
*
135135
* @apiSuccess {Object} deletedProject Details of the deleted project
136136
*
137-
* @apiError (400) BadRequest Some required fields are missing or invalid
138-
* @apiError (500) InternalServerError Internal server error
137+
* @apiError (Error 400) BadRequest Some required fields are missing or invalid
138+
* @apiError (Error 500) InternalServerError Internal server error
139139
*/
140140

141141

142142

143-
router.delete('/:projectId/delete', deleteProjects )
143+
router.delete('/:projectId', deleteProjects )
144144

145145
/**
146-
* @api {get} /api/v1/projects/:projectId/members Get members enrolled in a project
146+
* @api {get} /projects/:projectId/members Get members enrolled in a project
147147
* @apiName getMembersByProjectId
148148
* @apiGroup MemberProject
149149
*
150150
* @apiParam (Path Params) {Number} projectId ID of the project
151151
*
152152
* @apiSuccess {Object[]} members Array of members associated with the project
153153
*
154-
* @apiError (400) BadRequest Some required fields are missing
155-
* @apiError (500) InternalServerError Internal server error
154+
* @apiError (Error 400) BadRequest Some required fields are missing
155+
* @apiError (Error 500) InternalServerError Internal server error
156156
*/
157157

158158

159159
router.get('/:projectId/members', getMembersByProjectId )
160160

161161
/**
162-
* @api {post} /api/v1/projects/:projectId/members Add members to a project
162+
* @api {post} /projects/:projectId/members Add members to a project
163163
* @apiName addMembers
164164
* @apiGroup MemberProject
165165
*
@@ -168,16 +168,16 @@ export default function projectsRouter(
168168
*
169169
* @apiSuccess {Number} count Number of members successfully added
170170
*
171-
* @apiError (400) BadRequest Some required fields are missing
172-
* @apiError (500) InternalServerError Internal server error
171+
* @apiError (Error 400) BadRequest Some required fields are missing
172+
* @apiError (Error 500) InternalServerError Internal server error
173173
*/
174174

175175

176176
router.post('/:projectId/members' , addMembers )
177177

178178
// Remover the memnber
179179
/**
180-
* @api {delete} /api/v1/projects/:projectId/members/:memberId Remove a member from a project
180+
* @api {delete} /projects/:projectId/members/:memberId Remove a member from a project
181181
* @apiName removeMember
182182
* @apiGroup MemberProject
183183
*
@@ -186,8 +186,8 @@ export default function projectsRouter(
186186
*
187187
* @apiSuccess {Object} member The member that was removed
188188
*
189-
* @apiError (400) BadRequest Some required fields are missing
190-
* @apiError (500) InternalServerError Internal server error
189+
* @apiError (Error 400) BadRequest Some required fields are missing
190+
* @apiError (Error 500) InternalServerError Internal server error
191191
*/
192192

193193

0 commit comments

Comments
 (0)