feat: expose proctoring provider capability flags in instructor v2 API#38874
feat: expose proctoring provider capability flags in instructor v2 API#38874Anas12091101 wants to merge 1 commit into
Conversation
|
Thanks for the pull request, @Anas12091101! 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. |
0217533 to
c5088a4
Compare
Description
Adds two provider-capability flags to the instructor v2
proctoring_settingsendpoint so theinstructor dashboard MFE can decide whether to show the Student Onboarding Status and Review
Dashboard special-exam sections:
supports_onboarding— wrapsedx_proctoring.api.does_backend_support_onboarding(provider)review_dashboard_available— wrapsedx_proctoring.api.is_backend_dashboard_available(course_id)Both are computed in a small shared helper used by the endpoint's
GETandPATCH. This is the sameinformation the legacy instructor dashboard used server-side (
show_onboarding/show_dashboardin_section_special_exams), now exposed via the v2 API. No proctoring logic is reimplemented — theseare thin wrappers over existing edx-proctoring helpers.
Impacted user roles: Developers consuming the v2 API (two new read-only boolean fields);
Operators indirectly (the MFE gates UI on these). No behavior change for learners.
Closes #
Supporting information
frontend-app-instructor-dashboardPR feat: add Student Onboarding Status and Review Dashboard to Special Exams frontend-app-instructor-dashboard#219lms/djangoapps/instructor/docs/references/instructor-v2-special-exams-api-spec.yaml.Testing instructions
GET /api/instructor/v2/courses/{course_id}/proctoring_settingsas course staff.response includes
"supports_onboarding": trueand/or"review_dashboard_available": true.nullbackend, confirm both arefalse.pytest lms/djangoapps/instructor/tests/views/test_special_exams_api_v2.py::ProctoringSettingsViewTestOther information
is_backend_dashboard_availableinspects the course's active exams; cost is comparable to theexisting course-wide special-exam endpoints.