Missing status code 400 description in recommended-friends

[KostashchukIryna]

GreenCity PR

Issue Link 📋

#8024

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation for the findRecommendedFriends method by adding a detailed response code description for bad request scenarios (400 status code).

[coderabbitai]

Walkthrough

The pull request introduces a minor documentation enhancement to the FriendController class, specifically adding an @ApiResponse annotation for the 400 (Bad Request) status code in the findRecommendedFriends method. This change improves API documentation by explicitly defining the behavior for bad request scenarios, providing clearer guidance for API consumers about potential error responses.

Changes

File	Change Summary
core/src/main/java/greencity/controller/FriendController.java	Added @ApiResponse annotation for 400 status code in findRecommendedFriends method

Possibly related issues

• Issue #8024: Directly addresses the missing 400 status code description in the API documentation, providing the exact documentation improvement requested in the issue.

Poem

🌐 API docs, once bare and plain,
Now shine with clarity's refrain!
A 400 code, once left unseen,
Now documented, crisp and clean 🔍
Swagger smiles, developers cheer! 🎉

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

core/src/main/java/greencity/controller/FriendController.java (2)

258-259: LGTM! Documentation enhancement improves API clarity.

The addition of the 400 status code documentation aligns well with the rest of the controller's error handling patterns and improves API documentation consistency.

Consider adding a more specific description for the 400 error case, detailing what scenarios might trigger this response (e.g., invalid friend type). This would provide better guidance for API consumers.

-        @ApiResponse(responseCode = "400", description = HttpStatuses.BAD_REQUEST,
+        @ApiResponse(responseCode = "400", description = "Invalid request. Possible reasons: invalid recommended friends type or pagination parameters",

---

Line range hint 266-268: Enhance parameter documentation for better API clarity.

The type parameter's documentation could be more descriptive. Consider adding the supported values to the OpenAPI documentation to match the detailed information in the Javadoc.

-        @RequestParam(required = false) RecommendedFriendsType type,
+        @Parameter(description = "Type of friend recommendation. Supported values: FRIENDS_OF_FRIENDS, HABITS, CITY")
+        @RequestParam(required = false) RecommendedFriendsType type,

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9726035 and 37792ca.

📒 Files selected for processing (1)

• core/src/main/java/greencity/controller/FriendController.java (1 hunks)