docs(api): Add swagger docs of User Controller

[rajdip-b]

Type

documentation, enhancement

---

Description

• Enhanced Swagger documentation across various controllers and DTOs for better API documentation.
• Refactored OTP validation endpoint parameters from ApiParam to ApiQuery.
• Added authentication and security definitions to Swagger configuration in main.ts.
• Documented user controller endpoints with detailed request and response schemas.

---

Changes walkthrough

	Relevant files
Enhancement	auth.controller.ts Refactor OTP Validation Endpoint Parameters                            apps/api/src/auth/controller/auth.controller.ts Replaced ApiParam with ApiQuery for email and otp parameters in the OTP validation endpoint. +9/-3      main.ts Enhance Swagger Configuration with Authentication                apps/api/src/main.ts Added bearer authentication and API key security to Swagger configuration. +6/-0
Documentation	user.controller.ts Add Comprehensive Swagger Documentation to User Controller apps/api/src/user/controller/user.controller.ts Added Swagger decorators for API documentation in user controller endpoints. Included user schema for responses and added operation summaries and descriptions. Added ApiForbiddenResponse to endpoints for better error documentation. +57/-0    create.user.ts Document CreateUserDto Properties with Swagger                      apps/api/src/user/dto/create.user/create.user.ts Enhanced CreateUserDto with ApiProperty decorators for detailed API documentation. +55/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Description updated to latest commit (1eef0d2)

[codiumai-pr-agent-free]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are mostly related to Swagger annotations for API documentation, which are straightforward to review. The modifications include adding annotations for API documentation and security, which are generally low-risk and easy to validate against the Swagger/OpenAPI specifications.
🧪 Relevant tests	No
🔍 Possible issues	Possible Inconsistency: Ensure that the @ApiProperty decorators in DTOs accurately reflect the actual request and response structures. Any mismatch might lead to incorrect documentation.
	Security Definitions Clarity: While adding security definitions to Swagger is a good practice, ensure that these definitions are clear and accurately represent the security mechanisms in place. Ambiguities in security documentation can lead to misunderstandings about the API's security posture.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Code Suggestions

Category	Suggestions
Enhancement	Replace @ApiQuery with @ApiBody for endpoints consuming request body data. Consider using @ApiBody instead of @ApiQuery for endpoints that consume data in the body of the request. This provides a more accurate description of the API in the Swagger documentation. apps/api/src/auth/controller/auth.controller.ts [71-79] -@ApiQuery({ - name: 'email', - description: 'Email to send OTP', - required: true -}) -@ApiQuery({ - name: 'otp', - description: 'OTP to validate', - required: true +@ApiBody({ + schema: { + type: 'object', + properties: { + email: { type: 'string', description: 'Email to send OTP' }, + otp: { type: 'string', description: 'OTP to validate' } + }, + required: ['email', 'otp'] + } })
	Specify bearer token format in Swagger configuration. For enhanced security, consider specifying the bearerFormat in the addBearerAuth method to indicate whether the token is a JWT or another format. This helps users of your API understand the expected token format. apps/api/src/main.ts [100] -.addBearerAuth() +.addBearerAuth({ type: 'http', scheme: 'bearer', bearerFormat: 'JWT' })
	Add @IsEmail() validation for email fields. For the email field, consider adding a validation decorator @IsEmail() from class-validator to ensure the input is a valid email address. This enhances data integrity and validation on the server side. apps/api/src/user/dto/create.user/create.user.ts [17-27] -@IsString() +@IsEmail() @ApiProperty({ name: 'email', description: 'Email of the user', required: true, type: String, example: 'johndoe@keyshade.xyz', format: 'email', uniqueItems: true }) email: string
Maintainability	Extract common API response descriptions to shared variables. To avoid repetition and improve maintainability, consider extracting common response descriptions into a shared variable or function. This is particularly useful for standard responses like 'Invalid authentication token or API key'. apps/api/src/user/controller/user.controller.ts [67] -@ApiForbiddenResponse({ +const invalidAuthResponse = { description: 'Invalid authentication token or API key' -}) +}; +@ApiForbiddenResponse(invalidAuthResponse) +
Best practice	Use @ApiNoContentResponse for endpoints with possible no content responses. To ensure the API documentation is clear and useful, consider adding @ApiNoContentResponse for endpoints that might not return content, specifying the possible status codes and their meanings. apps/api/src/user/controller/user.controller.ts [101-106] @ApiForbiddenResponse({ description: 'Invalid authentication token' }) -@ApiResponse({ - status: 204, +@ApiNoContentResponse({ description: 'User deleted successfully' })

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.78%. Comparing base (7bb3d21) to head (1eef0d2).
Report is 27 commits behind head on develop.

❗ Current head 1eef0d2 differs from pull request most recent head 0e346e8. Consider uploading reports for the commit 0e346e8 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #166       +/-   ##
============================================
+ Coverage    62.20%   94.78%   +32.57%     
============================================
  Files           76       90       +14     
  Lines         1503     1993      +490     
  Branches       260      394      +134     
============================================
+ Hits           935     1889      +954     
+ Misses         568      104      -464     

Flag	Coverage Δ
api-e2e-tests	94.78% <100.00%> (+32.57%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀