feat: implement instructor API v2 grading GET endpoints#37890
feat: implement instructor API v2 grading GET endpoints#37890brianjbuck-wgu wants to merge 1 commit intoopenedx:masterfrom
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @brianjbuck-wgu! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
mphilbrick211
added
the
mao-onboarding
brianjbuck-wgu
force-pushed
the
feature/37889-instructor-dashboard-grading-get-endpoints
branch
from
a143cc2 to
7cfdc7a
Compare
brianjbuck-wgu
force-pushed
the
feature/37889-instructor-dashboard-grading-get-endpoints
branch
2 times, most recently
from
8bdff7a to
dcc4052
Compare
brianjbuck-wgu
force-pushed
the
feature/37889-instructor-dashboard-grading-get-endpoints
branch
from
dcc4052 to
a26adc7
Compare
brianjbuck-wgu
force-pushed
the
feature/37889-instructor-dashboard-grading-get-endpoints
branch
2 times, most recently
from
1b5b753 to
f3418b2
Compare
brianjbuck-wgu
force-pushed
the
feature/37889-instructor-dashboard-grading-get-endpoints
branch
from
f3418b2 to
addc687
Compare
dwong2708
left a comment
dwong2708
left a comment
There was a problem hiding this comment.
Looks nice. Just a couple of suggestions and I was wondering if there is way to avoid repetitions at the moment of get the course id and its validation.
| ) | ||
|
|
||
| try: | ||
| student = get_student_from_identifier(email_or_username) |
There was a problem hiding this comment.
I noticed get_student_from_identifier is deprecated. However, it is pointing to get_user_by_username_or_email that is not deprecated. I recommend use directly the no deprecated one in case of get_student_from_identifier is removed.
| 'last_name': student.last_name, | ||
| 'progress_url': progress_url, | ||
| 'gradebook_url': gradebook_url, | ||
| 'current_score': None, |
There was a problem hiding this comment.
is there a special reason these are None values?
| 'breadcrumbs': [b for b in breadcrumbs if b.get('usage_key') is not None or breadcrumbs.index(b) == 0] | ||
| } | ||
|
|
||
| from .serializers_v2 import ProblemSerializer |
There was a problem hiding this comment.
Please move this import at the top of the file
|
|
||
| # Add progress if available | ||
| if hasattr(task, 'task_output') and task.task_output: | ||
| import json |
There was a problem hiding this comment.
Please move this import at the top of the file
|
|
||
| try: | ||
| student = get_student_from_identifier(email_or_username) | ||
| except Exception: # pylint: disable=broad-except |
There was a problem hiding this comment.
The function get_user_by_username_or_email raises the following exceptions:
- User.DoesNotExist if no user object can be found, the user was retired, or the user is in the process of being retired.
- MultipleObjectsReturned if one user has same email as username of second user
- MultipleObjectsReturned if more than one user has same email or username
Would it be worth to return the correct response messages accordingly?
| 'message': str(task.task_output) if task.task_output else 'Task failed' | ||
| } | ||
|
|
||
| from .serializers_v2 import TaskStatusSerializer |
I tested first endpoint and im not getting my first name and last name 😞 and can we get fullname instead? 🤔
|
5 participants
Summary
This PR implements three new GET endpoints for the Instructor Dashboard API v2 grading operations, as specified in the OpenAPI schema from #37743.
New Endpoints:
GET /api/instructor/v2/courses/{course_id}/learners/{email_or_username}
GET /api/instructor/v2/courses/{course_id}/problems/{location}
GET /api/instructor/v2/courses/{course_id}/tasks/{task_id}
All endpoints follow existing instructor API v2 patterns with proper authentication, permission checks, and error handling.