Some minor fixes in api annotations

[Sherin-2711]

Summary by CodeRabbit

• Documentation
  • Updated API documentation to use @apiBody instead of @apiParam for request body and form data parameters across achievements, interviews, and projects endpoints.
  • Improved clarity and accuracy of API documentation for endpoints handling file uploads and JSON data.
• Chores
  • Updated .gitignore to exclude the /doc directory from version control.

[coderabbitai]

Walkthrough

The changes update API documentation annotations in multiple route files by replacing @apiParam with @apiBody for request body and form data parameters. Additionally, the .gitignore file is updated to exclude the /doc directory from version control. No runtime logic or exported entity signatures are modified.

Changes

File(s)	Change Summary
.gitignore	Added /doc directory to ignored paths.
src/routes/achievements.ts	Updated API doc comments: replaced @apiParam (FormData) with @apiBody (FormData) for relevant fields.
src/routes/interviews.ts	Updated API doc comments: replaced @apiParam (Request Body) with @apiBody (Request Body).
src/routes/projects.ts	Updated API doc comments: replaced @apiParam with @apiBody for body/form data parameters.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

• Harish-Naruto

Poem

A hop and a skip, the docs are now neat,
With @apiBody tags, our routes are complete!
The /doc folder hidden, no clutter in sight,
Review will be easy, the changes are light.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-24T09_05_10_864Z-debug-0.log

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch minor-fixes

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/routes/projects.ts (2)

91-96: Parameter casing inconsistency (AdminId vs adminId)
Create-endpoint uses AdminId (capital A) while the update endpoint (below) uses adminId. Pick one spelling to avoid consumer confusion and validation bugs.

- * @apiBody (FormData) {UUID} AdminId ID of the admin creating the project
+ * @apiBody (FormData) {UUID} adminId ID of the admin creating the project

---

112-116: Mixed annotation scopes – “Body”, “Request Body”, “FormData”
In this block you introduced (Body) and (Form Data) whereas the create endpoint uses (FormData) and the members endpoint uses (Request Body). Pick one of the three so ApiDoc groups them together.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c10e25 and 08a194b.

📒 Files selected for processing (4)

• .gitignore (1 hunks)
• src/routes/achievements.ts (2 hunks)
• src/routes/interviews.ts (2 hunks)
• src/routes/projects.ts (3 hunks)

🔇 Additional comments (4)

.gitignore (1)

142-143: Double-check whether /doc should be ignored in all environments
Ignoring generated docs keeps the repo clean, but make sure the CI/CD (or whatever publishes the API docs) does not rely on committing that folder. If a later step expects /doc to exist in the repo, this rule will break the pipeline.

src/routes/achievements.ts (1)

56-58: API-Doc tag switch is correct – no issues spotted
@apiParam ➔ @apiBody is the right choice for body/form-data params. No functional impact.

Also applies to: 77-79

src/routes/interviews.ts (1)

65-70: Documentation tags updated consistently – looks good
The change aligns with the new convention and will generate cleaner docs.

Also applies to: 84-89

src/routes/projects.ts (1)

167-168: Good switch to @apiBody
The members endpoint now documents its request body correctly.