Skip to content

Commit f10f18b

Browse files
committed
apidoc changes
1 parent 137a0db commit f10f18b

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

src/routes/projects.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ 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)
@@ -76,8 +76,8 @@ export default function projectsRouter(
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)
@@ -96,8 +96,8 @@ 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

103103
router.post('/', upload.single('image') , parseCreateProjectData , createProject )
@@ -117,8 +117,8 @@ 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

124124
router.patch('/:projectId', upload.single('image') , parseCreateProjectData , updateProjects )
@@ -134,8 +134,8 @@ export default function projectsRouter(
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

@@ -151,8 +151,8 @@ export default function projectsRouter(
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

@@ -168,8 +168,8 @@ 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

@@ -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)