Skip to content

feat: Add special exams v2 API to instructor dashboard#38359

Draft
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:feature/37470-special-exams-api
Draft

feat: Add special exams v2 API to instructor dashboard#38359
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:feature/37470-special-exams-api

Conversation

@brianjbuck-wgu
Copy link
Copy Markdown
Contributor

@brianjbuck-wgu brianjbuck-wgu commented Apr 14, 2026

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}/):

Method Path Description
GET /special_exams List all proctored/timed exams in a course
GET /special_exams/{exam_id} Retrieve details for a specific exam
POST /special_exams/{exam_id}/reset/{username} Reset a student's exam attempt
GET /special_exams/{exam_id}/attempts List all attempts for an exam
GET /proctoring_settings Retrieve course proctoring configuration
PATCH /proctoring_settings Update course proctoring settings
POST /special_exams/{exam_id}/allowance Grant a time extension or accommodation

Impacted user roles: Course Staff, Instructors (users with EXAM_RESULTS or VIEW_DASHBOARD permissions).

Supporting information

Other information

  • No database migrations — all data is sourced from edx_proctoring APIs and modulestore course fields.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 14, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @brianjbuck-wgu!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If 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 PR

Your 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread lms/djangoapps/instructor/views/api_v2.py Outdated
Comment thread lms/djangoapps/instructor/views/api_v2.py
Comment thread lms/djangoapps/instructor/views/api_v2.py
Comment thread lms/djangoapps/instructor/views/api_v2.py
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Apr 16, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

Special Exams API

4 participants