You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ProductsController currently lacks support for product reviews, star ratings, and comments. This limits user engagement and prevents customers from leaving valuable feedback directly on products.
This feature will allow authenticated users to:
Submit or update a review with a star rating (1-5) and review text.
Post comments on a product for open-ended discussion.
View existing reviews, average rating, and recent comments when retrieving product details.
This will enhance user experience, increase transparency, and provide organizations with actionable feedback to improve their products.
Acceptance Criteria
Add new POST endpoints for:
Submitting or updating a review (rating + review text).
Posting a comment on a product.
Add a DELETE endpoint for removing a user’s review.
Enhance the existing GET product details endpoint to include:
average_rating
total_reviews
Recent comments and reviews.
Apply authentication rules: only the review owner can modify or delete a review.
Document all new endpoints in Swagger, including request/response examples.
Update the response structure to follow standard API format (status, message, data).
Purpose
This enhancement serves to:
Enable customers to leave meaningful feedback on products.
Display real user reviews and ratings, increasing product credibility.
Foster open discussions through product comments.
Collect structured feedback for product improvement.
Align with best practices for modern product catalog APIs.
Jhaemis-hack
changed the title
[FEAT] Implement Product Review, Star Rating, and Comment Feature
[FEAT] Implement Product Review and Star Rating Feature
Feb 28, 2025
Description
The
ProductsController
currently lacks support for product reviews, star ratings, and comments. This limits user engagement and prevents customers from leaving valuable feedback directly on products.This feature will allow authenticated users to:
This will enhance user experience, increase transparency, and provide organizations with actionable feedback to improve their products.
Acceptance Criteria
average_rating
total_reviews
Purpose
This enhancement serves to:
Requirements
Controller Enhancements
/organisations/{orgId}/products/{productId}/reviews
/organisations/{orgId}/products/{productId}/reviews
/organisations/{orgId}/products/{productId}/comments
/organisations/{orgId}/products/{productId}/reviews
/organisations/{orgId}/products/{productId}
⚙️ Expected Outcomes
Example Response - Review Creation
The text was updated successfully, but these errors were encountered: