feat: ORA staff grader endpoints upgrade #10
Conversation
| if data['assessment_type'] == "received": | ||
| return generate_received_assessment_data(subission_uuid) | ||
| else: | ||
| return generate_given_assessment_data(item_id, subission_uuid) |
There was a problem hiding this comment.
is this given and received as the assessment type present elsewhere? can we elaborate on the meaning of each?
There was a problem hiding this comment.
I believe the default should be list all assessments for the submission uuid, so received.
There was a problem hiding this comment.
why is a single handler better than separating concerns? list_assessments_received or list_assessments_given are more explicit than list_assessments..., but I don't have other strong arguments
There was a problem hiding this comment.
In the MFE, it's just a table with a filter button; the data output has the same format. At the backend level, it's just a design decision that, compared to having two handlers, neither adds nor subtracts anything; it's pretty much the same.
There was a problem hiding this comment.
It's not the same. When using a single handler with a variable assessment_type, which defaults to given, you are making a decision there, you're saying the defaults assessments returned are given by students on the submission. When using two handlers, the client can actively decide which one to call without guessing the system's default. Don't you think?
There was a problem hiding this comment.
Yeah! that's true... but it does not exists a request without assessment_type (now called assessment_filter), it will always be given or received...
In fact, it is a required param in the AssessmentFeedbackView of edx-platform and declared in lms/djangoapps/ora_staff_grader/constants.py so, list_assessments() would be never called without assessment_filter...
jeje, but now tha you are saying this... I think that in form, this will look even better 😃
filter_value = data['assessment_filter']
if filter_value == "received":
return generate_received_assessment_data(subission_uuid)
elif filter_value == "given":
return generate_given_assessment_data(item_id, subission_uuid)
else:
raise ValueError("Invalid assessment_filter value")
for optimized user data retrieval.
nandodev-net
changed the title
nandodev-net
changed the title
ORA staff grader endpoints upgrade
For this PR we have the following goals:
/api/ora_staff_grader/assessments/feedbackendpoint in order to list the assessments grades based on the type (received or given) for a specific submission./api/ora_staff_grader/initializeendpoint in order to add thefullnameandemailfields.Descriptions
/api/ora_staff_grader/assessments/feedback
This endpoint fetches assessment details for a given submission UUID, assessment_fillter [
given,received] and ORA_location, including scorer information and scoring details in order to fill the following Staff Grade MFE table:Click here! to see `/api/ora_staff_grader/assessments/feedback` output
{ "assessments": [ { "id_assessment": "17", "scorer_name": "Fernando Gonzalez", "scorer_username": "admin", "scorer_email": "[email protected]", "assesment_date": "17-10-2023", "assesment_scores": [ { "criterion_name": "Ideas", "score_earned": 5, "score_type": "Good" }, { "criterion_name": "Content", "score_earned": 5, "score_type": "Excellent" } ], "problem_step": "Staff", "feedback": "OVERALL WENO" }, ] }/api/ora_staff_grader/initialize
This is a pre-existing endpoint to which two extra fields are added [
fullname,email].Modifications were made in the following directories:
Click here! to see `/api/ora_staff_grader/initialize` output
Testing
In order to test this, you can use the API platform Postman:
given,received]This upgrade will consist of two PRs: one for ORA and the other for edx-platform. This is because the main serializer of the service resides in the platform. To test it, you'll need to fetch and set up the version of the platform with the serializer modification.