feat: Add special exams v2 API to instructor dashboard#38359
feat: Add special exams v2 API to instructor dashboard#38359brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
Conversation
|
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. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. Where 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. |
There was a problem hiding this comment.
Pull request overview
Adds a set of Instructor API v2 endpoints to support “special exams” (proctored/timed) workflows in the Instructor Dashboard, delegating exam/attempt/allowance operations to edx_proctoring and exposing course-level proctoring settings.
Changes:
- Added new DRF serializers for special exams, exam attempts, proctoring settings, and allowance requests.
- Introduced new v2 API views + URL routes for listing exams, viewing exam details, listing attempts, resetting attempts, updating proctoring settings, and granting allowances.
- Added API v2 tests and a Swagger (OpenAPI v2) reference spec for the new endpoints.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
lms/djangoapps/instructor/views/serializers_v2.py |
Adds serializers that shape proctoring/exam payloads for the new endpoints. |
lms/djangoapps/instructor/views/api_v2.py |
Implements the new Special Exams + Proctoring Settings endpoints and integrates edx_proctoring APIs. |
lms/djangoapps/instructor/views/api_urls.py |
Registers the new Instructor API v2 routes. |
lms/djangoapps/instructor/tests/views/test_special_exams_api_v2.py |
Adds coverage for the new endpoints using mocked edx_proctoring calls where needed. |
lms/djangoapps/instructor/docs/references/instructor-v2-special-exams-api-spec.yaml |
Documents the new endpoints in the instructor v2 API reference set. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
Adds Instructor API v2 endpoints for managing proctored and timed ("special") exams, as part of the ongoing Instructor Dashboard MFE migration.
New endpoints (all under /api/instructor/v2/courses/{course_id}/):
Impacted user roles: Course Staff, Instructors (users with EXAM_RESULTS or VIEW_DASHBOARD permissions).
Supporting information
Other information