Merge pull request #17 from call-0f-code/minor-fixes

Some minor fixes in api annotations

Author: Harish-Naruto

.gitignore

@@ -139,3 +139,5 @@ vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
 
 /src/generated/prisma
+
+/doc

src/routes/achievements.ts

@@ -53,8 +53,8 @@ export default function acheivementsRouter(upload: Multer, supabase: SupabaseCli
    * @apiName createAchievement
    * @apiGroup Achievement
    *
-   * @apiParam (FormData) {File} image Image file
-   * @apiParam (FormData) {String} achievementData JSON string of achievement fields:
+   * @apiBody (FormData) {File} image Image file
+   * @apiBody (FormData) {String} achievementData JSON string of achievement fields:
    *   - title: string
    *   - description: string
    *   - achievedAt: Date
@@ -74,8 +74,8 @@ export default function acheivementsRouter(upload: Multer, supabase: SupabaseCli
    * @apiGroup Achievement
    *
    * @apiParam (Path Params) {Number} achievementId Achievement ID
-   * @apiParam (FormData) {File} [image] Optional new image
-   * @apiParam (FormData) {String} achievementData JSON string of updated fields:
+   * @apiBody (FormData) {File} [image] Optional new image
+   * @apiBody (FormData) {String} achievementData JSON string of updated fields:
    *   - title?: string
    *   - description?: string
    *   - achievedAt?: Date

src/routes/interviews.ts

@@ -62,11 +62,11 @@ export default function interviewRouter(upload: Multer, supabase: SupabaseClient
    * @apiGroup Interview
    *
    * @apiParam (Path Params) {UUID} memberId ID of the member sharing the interview
-   * @apiParam (Request Body) {String} company Name of the company
-   * @apiParam (Request Body) {String} role Role applied for
-   * @apiParam (Request Body) {String="Selected","Rejected","Pending"} verdict Result of the interview
-   * @apiParam (Request Body) {String} content Experience content
-   * @apiParam (Request Body) {Boolean} isAnonymous Whether the post is anonymous
+   * @apiBody (Request Body) {String} company Name of the company
+   * @apiBody (Request Body) {String} role Role applied for
+   * @apiBody (Request Body) {String="Selected","Rejected","Pending"} verdict Result of the interview
+   * @apiBody (Request Body) {String} content Experience content
+   * @apiBody (Request Body) {Boolean} isAnonymous Whether the post is anonymous
    *
    * @apiSuccess {Object} interview Created interview experience
    *
@@ -81,12 +81,12 @@ export default function interviewRouter(upload: Multer, supabase: SupabaseClient
    * @apiGroup Interview
    *
    * @apiParam (Path Params) {Number} id Interview ID to update
-   * @apiParam (Request Body) {UUID} memberId Member ID of the owner
-   * @apiParam (Request Body) {String} [company] Company name
-   * @apiParam (Request Body) {String} [role] Role
-   * @apiParam (Request Body) {String="Selected","Rejected","Pending"} [verdict] Interview result
-   * @apiParam (Request Body) {String} [content] Experience content
-   * @apiParam (Request Body) {Boolean} [isAnonymous] Anonymous flag
+   * @apiBody (Request Body) {UUID} memberId Member ID of the owner
+   * @apiBody (Request Body) {String} [company] Company name
+   * @apiBody (Request Body) {String} [role] Role
+   * @apiBody (Request Body) {String="Selected","Rejected","Pending"} [verdict] Interview result
+   * @apiBody (Request Body) {String} [content] Experience content
+   * @apiBody (Request Body) {Boolean} [isAnonymous] Anonymous flag
    *
    * @apiSuccess {Object} interview Updated interview experience
    *

src/routes/projects.ts

@@ -88,11 +88,11 @@ export default function projectsRouter(
  * @apiName createProject
  * @apiGroup Project
  * 
- * @apiParam (FormData) {String} name Name of the project
- * @apiParam (FormData) {File} image Image file for the project
- * @apiParam (FormData) {String} githubUrl GitHub URL of the project
- * @apiParam (FormData) {String} deployUrl Deployment link of the project
- * @apiParam (FormData) {UUID} AdminId ID of the admin creating the project
+ * @apiBody (FormData) {String} name Name of the project
+ * @apiBody (FormData) {File} image Image file for the project
+ * @apiBody (FormData) {String} githubUrl GitHub URL of the project
+ * @apiBody (FormData) {String} deployUrl Deployment link of the project
+ * @apiBody (FormData) {UUID} AdminId ID of the admin creating the project
  * 
  * @apiSuccess {Object} project The created project object
  * 
@@ -109,11 +109,11 @@ export default function projectsRouter(
  * @apiGroup Project
  *
  * @apiParam (Path Params) {Number} projectId ID of the project to update
- * @apiParam (Body)        {String} [name] Name of the project (optional)
- * @apiParam (Body)        {String} [githubUrl] GitHub URL of the project (optional)
- * @apiParam (Body)        {String} [deployUrl] Deployment link of the project (optional)
- * @apiParam (Body)        {UUID}   adminId ID of the admin updating the project (required)
- * @apiParam (Form Data)   {File}   [image] Image file (optional)
+ * @apiBody (Body)        {String} [name] Name of the project (optional)
+ * @apiBody (Body)        {String} [githubUrl] GitHub URL of the project (optional)
+ * @apiBody (Body)        {String} [deployUrl] Deployment link of the project (optional)
+ * @apiBody (Body)        {UUID}   adminId ID of the admin updating the project (required)
+ * @apiBody (Form Data)   {File}   [image] Image file (optional)
  *
  * @apiSuccess {Object} project Updated project data
  *
@@ -164,7 +164,7 @@ export default function projectsRouter(
  * @apiGroup MemberProject
  * 
  * @apiParam (Path Params) {Number} projectId ID of the project
- * @apiParam (Request Body) {UUID[]} memberIds Array of member IDs to add to the project
+ * @apiBody (Request Body) {UUID[]} memberIds Array of member IDs to add to the project
  * 
  * @apiSuccess {Number} count Number of members successfully added
  *