Skip to content

Conversation

@AhtishamShahid
Copy link
Contributor

@AhtishamShahid AhtishamShahid commented Nov 3, 2025

Description

Issue : #37465

This PR added API endpoint to get course modes for instructor dashboard .

/api/instructor/v1/courses/{course_key}/modes

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "modes": [
        {
            "mode_slug": "audit",
            "mode_display_name": "Audit Track",
            "min_price": 0,
            "currency": "USD",
            "expiration_datetime": null,
            "description": "Access the course materials for free, but without a certificate.",
            "sku": null,
            "android_sku": null,
            "ios_sku": null,
            "bulk_sku": null
        },
        {
            "mode_slug": "verified",
            "mode_display_name": "Verified Track",
            "min_price": 49,
            "currency": "USD",
            "expiration_datetime": null,
            "description": "Access all materials, graded assignments, and earn a verified certificate.",
            "sku": null,
            "android_sku": null,
            "ios_sku": null,
            "bulk_sku": null
        }
    ]
}

@AhtishamShahid AhtishamShahid marked this pull request as draft November 3, 2025 13:53
@AhtishamShahid AhtishamShahid force-pushed the ahtisham/add_course_modes_apis branch from 69a052f to 30d0d7e Compare November 5, 2025 09:07
@AhtishamShahid AhtishamShahid marked this pull request as ready for review November 5, 2025 09:08
def _cohorts_csv_validator(file_storage, file_to_validate):
"""
Verifies that the expected columns are present in the CSV used to add users to cohorts.
Verifies that the expected columns are present in the CSV` used to add users to cohorts.
Copy link
Member

Choose a reason for hiding this comment

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

Typo?

Response: A DRF Response object containing the serialized
course modes or an error.
"""
if not CourseOverview.objects.filter(id=course_id).exists():
Copy link
Member

Choose a reason for hiding this comment

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

This is a redundant check, if course doesn't exist we will get 404 in permission check. we can safely skip this.

fix: resolved linter errors

chore: added docs to api

fix: removed redundant code

fix: removed redundant code
@AhtishamShahid AhtishamShahid force-pushed the ahtisham/add_course_modes_apis branch from 34201ee to 6d0bf82 Compare November 7, 2025 07:34
@awais786 awais786 requested a review from Copilot November 7, 2025 09:43
Copy link
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

This PR adds a new API endpoint to retrieve course enrollment modes (e.g., audit, verified) for instructors and staff, along with comprehensive test coverage.

  • Adds CourseModeListView API endpoint for fetching enrollment modes
  • Creates CourseModeSerializer and CourseModeListSerializer for API responses
  • Implements authentication/authorization checks and comprehensive tests

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.

File Description
lms/djangoapps/instructor/views/serializer.py Adds CourseModeSerializer and CourseModeListSerializer to serialize course mode data
lms/djangoapps/instructor/views/api_urls.py Registers the new course_modes_list endpoint in the v1 API URL patterns
lms/djangoapps/instructor/views/api.py Implements CourseModeListView class with GET handler and documentation
lms/djangoapps/instructor/tests/test_api.py Adds comprehensive test suite covering authentication, permissions, and response validation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 10, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @AhtishamShahid!

This repository is currently maintained by @openedx/wg-maintenance-edx-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.


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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Nov 10, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Nov 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants