Home

Welcome to the xintern-reviews-api wiki!

getRecentReviews

• Path: review/recent
• Query params: num: {number of reviews}
• Populate Company, Rating, User

getReviewsByCompany

• Path: review
• Query params: comanpy_id: {company_id}
• Populate Company, Rating, User
• Should have some type of sorting

getPopulatedReview

• Get Review obj with references all populated & Comments sorted
• Path: /populated-review/{review_id}
• Comments need to be sorted to reflect proper tree structure/hierarchy

upvoteReview

• When a Review gets upvoted
• Path: /review/{review_id}/upvote

downvoteReview

• When a Review gets downvoted
• Path: /review/{review_id}/downvote

flagReview

• When a Review gets flagged
• Path: /review/{review_id}/flag

updateReview

• Updates just the Review-related properties (i.e content, position, etc)
• Path: /review/{review_id}