Skip to content

feat: add AuthZ permissions for course schedule & details#38213

Open
dwong2708 wants to merge 6 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/authz-new-perms-schedule-details
Open

feat: add AuthZ permissions for course schedule & details#38213
dwong2708 wants to merge 6 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/authz-new-perms-schedule-details

Conversation

@dwong2708
Copy link
Copy Markdown
Contributor

@dwong2708 dwong2708 commented Mar 25, 2026

Description

This PR introduces new AuthZ permission checks for the Schedule & Details section in course settings, implemented behind a feature flag.

The work follows the requirements defined in the ticket, covering both read and update operations for course schedule and details.

Scope of Changes

Permissions introduced:

  • courses.view_schedule_and_details
  • course.edit_schedule
  • course.edit_details
  • course.view_course

Endpoints updated:

GET /api/contentstore/v1/course_settings/{course_id}/
GET /api/contentstore/v1/course_details/{course_id}/
PUT /api/contentstore/v1/course_details/{course_id}/

All permission checks are gated behind the corresponding feature flag.

Implementation Details

  • GET endpoints. Require courses.view_schedule_and_details permission.
  • PUT endpoint
    • Handles updates for both schedule and details in a single request.
    • Introduce payload-level inspection to differentiate between schedule and details updates, and enforce permissions accordingly.
  • Due to the merged data model (schedule + details updated together), enforcing separate permissions (course.edit_schedule vs course.edit_details) at field level would introduce additional complexity and performance overhead.

Testing instructions

Verified that:

  • Authorized users can access the endpoints.
  • Unauthorized users receive a 403 response.
  • Legacy permission fallback works as expected.

Running relevant tests manually:

On a cms container (run with tutor dev exec cms bash), do:

pytest -p no:randomly --ds=cms.envs.test cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_details.py::CourseDetailsAuthzViewTest

pytest -p no:randomly --ds=cms.envs.test cms/djangoapps/contentstore/rest_api/v1/views/tests/test_settings.py

Deadline

Verawood

Other information

Closes openedx/openedx-authz#195

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

openedx-webhooks commented Mar 25, 2026

Thanks for the pull request, @dwong2708!

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.

Details
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 Mar 25, 2026
@dwong2708 dwong2708 changed the title Dwong2708/authz new perms schedule details feat: add AuthZ permissions for course schedule & details (behind feature flag) Mar 25, 2026
@dwong2708 dwong2708 changed the title feat: add AuthZ permissions for course schedule & details (behind feature flag) feat: add AuthZ permissions for course schedule & details Mar 25, 2026
@dwong2708 dwong2708 marked this pull request as ready for review March 25, 2026 16:39
Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

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

Just some nits and changes needed due to other PRs already merged in master.

Please make sure to rebase from master to make sure nothing breaks.

@mphilbrick211 mphilbrick211 added Make Upgrade In Progress mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). and removed Make Upgrade In Progress labels Mar 27, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Mar 27, 2026
@dwong2708 dwong2708 force-pushed the dwong2708/authz-new-perms-schedule-details branch from 93e2c75 to fa7ea64 Compare March 27, 2026 22:25
@dwong2708 dwong2708 requested a review from rodmgwgu March 27, 2026 23:42
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: In Eng Review

Development

Successfully merging this pull request may close these issues.

Task - RBAC AuthZ - Implement new permissions for schedule & details

4 participants