Teacher Reviews API

[arafaysaleem]

Description

This epic is a goal of the larger epic of Complete REST API and contains functionality for teacher reviews in our project. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

We want to be able to manage teacher reviews so that students can add and read reviews and make decisions accordingly. We also want to moderate reviews before we allow them to be included in the calculation or directory of overall PR.

Hypothesis

The API must provide management of teacher reviews. This epic is considered complete when the following features are complete:

• Teacher Reviews Management
• Documentation
• Tests

Acceptance criteria and must have scope

We must have Authentication, Teachers, Subjects and Students API setup prior to this. In the end we need to have a collection of following endpoints:

• [GET] All Teacher Reviews #171
• [GET] A Single Teacher Review #172
• [POST] A New Teacher Review #173
• [PATCH] A Teacher Review #174
• [DELETE] A Teacher Review #175

Note: 🔒 symbol indicates the route is protected and accessible to admin only

Stakeholders

None

Timeline

2 days are needed to setup all the foundation, along with testing and documentation. No blockers expected.

[arafaysaleem]

For updating the average rating of a teacher use the Bezhanov Algorithm as explained here

The Formula

Rating_{new_avg} = (Rating_{old_avg} * N_old + Rating_new) /(N_old+1)

[arafaysaleem]

Completed In #176