feat: add is_enrolled field to learners endpoint response#38405
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @dwong2708! 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. |
There was a problem hiding this comment.
Pull request overview
This PR extends the Instructor API v2 learner detail endpoint to include a learner’s current enrollment status (is_enrolled) and adds/updates tests to validate the new response field.
Changes:
- Add
is_enrolledtoLearnerSerializeroutput schema. - Populate
is_enrolledinLearnerViewviaCourseEnrollment.is_enrolled(...). - Extend learner detail endpoint tests to cover enrolled vs non-enrolled scenarios.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
lms/djangoapps/instructor/views/serializers_v2.py |
Adds is_enrolled boolean field to the learner response serializer. |
lms/djangoapps/instructor/views/api_v2.py |
Includes is_enrolled in the learner detail response and updates the documented example JSON. |
lms/djangoapps/instructor/tests/views/test_api_v2.py |
Adds assertions and a new test case to verify is_enrolled behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dwong2708
requested review from
brianjbuck-wgu,
diana-villalvazo-wgu and
wgu-taylor-payne
|
Tested on this PR openedx/frontend-app-instructor-dashboard#170 and works as expected 👍 |
wgu-taylor-payne
left a comment
wgu-taylor-payne
left a comment
There was a problem hiding this comment.
Looks good. A couple of small suggestions.
| 'email': student.email, | ||
| 'full_name': student.profile.name, | ||
| 'progress_url': progress_url, | ||
| 'is_enrolled': CourseEnrollment.is_enrolled(student, course_key), |
There was a problem hiding this comment.
| 'is_enrolled': CourseEnrollment.is_enrolled(student, course_key), | |
| 'is_enrolled': is_user_enrolled_in_course(student, course_key), |
dwong2708
force-pushed
the
dwong2708/fix-learners-isenrolled
branch
from
bdf9a1b to
028aa81
Compare
mphilbrick211
added
the
mao-onboarding
Description
This PR adds a new is_enrolled field to the learners endpoint and integrates it into the Instructor Dashboard UI.
The goal is to expose enrollment status directly in the learners data, enabling the frontend to display or act on whether a learner is currently enrolled in a course without requiring additional API calls.
Related Issue
openedx/frontend-app-instructor-dashboard#164
Changes:
Add is_enrolled field to learners endpoint response
Update frontend data handling to include the new field
Ensure compatibility with existing learners view/components
Notes
This change is backward compatible (adds a new field without modifying existing ones)
No impact expected on existing functionality
Deadline
Verawood