Skip to content

feat: update course permission categories to match the roles proposal - #636

Open
BryanttV wants to merge 1 commit into
bav/hidden-categories-and-permissionsfrom
bav/update-course-roles-permissions-matrix
Open

BryanttV wants to merge 1 commit into
bav/hidden-categories-and-permissionsfrom
bav/update-course-roles-permissions-matrix

Conversation

@BryanttV

@BryanttV BryanttV commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Description

The course permission categories and permissions did not match the product proposal for the Roles and Permissions console. Some permissions lived in categories where users would not look for them, two categories were nearly empty, and several descriptions did not say where the permission applies. This PR aligns the schema with the proposal. It only changes catalog metadata: role grants and permission checks are unchanged.

  • Moves permissions to their new categories:
    • courses.view_course_info and courses.view_checklists → course_access_content ("Course access & content").
    • courses.export_tags → course_tags_taxonomies ("Tags").
    • courses.view_group_configurations and courses.manage_group_configurations → course_cohorts_content_groups ("Cohorts & content groups").
  • Removes the course_information and course_other categories, which are now empty.
  • Renames categories (display name and, where noted, ID):
    • course_grading → course_grading_settings: "Grading" → "Grading settings".
    • course_team_group → course_team: "Course team & groups" → "Course team".
    • course_cohorts → course_cohorts_content_groups: "Cohorts" → "Cohorts & content groups".
    • course_advanced_certificates → course_advanced_settings_certificates: "Advanced & certificates" → "Advanced settings & certificates".
    • course_import_export: "Import/export" → "Course import & export" (ID unchanged).
  • Rewrites category and permission descriptions so they say whether the permission applies in Studio, the Instructor Dashboard, or the Roles and Permissions console.
  • Marks courses.manage_taxonomies as hidden, using the flag from feat: add hidden property to permission categories and permissions #634. The permission is still granted to course_admin but no longer appears in the catalog.
  • Regenerates docs/references/compiled-schema.yaml and adds a CHANGELOG.rst entry.

Affected roles: none for access. The role and permission catalog in the Roles and Permissions console shows the new grouping, names, and descriptions to Operators and Course Admins.

Supporting Information

Testing Instructions

  1. Check out this branch and install the dependencies:

    uv sync --group dev --active
  2. Run the schema and catalog tests:

    pytest src/openedx_authz/tests/schema src/openedx_authz/tests/api/test_catalog.py

    Expected: all tests pass.

  3. Regenerate the compiled schema and confirm it is in sync with the YAML sources:

    make compiled_schema
    git diff --exit-code docs/references/compiled-schema.yaml

    Expected: no diff.

  4. Load the schema and list the course categories and permissions through the catalog API (for example, with python manage.py shell after the schema is applied). Verify that:

    • course_information, course_other, course_cohorts, course_team_group, and course_grading no longer exist.
    • course_cohorts_content_groups, course_team, course_grading_settings, and course_advanced_settings_certificates exist and contain the same permissions as the categories they replace.
    • view_course_info and view_checklists are in course_access_content, export_tags is in course_tags_taxonomies, and the two group configuration permissions are in course_cohorts_content_groups.
    • courses.manage_taxonomies is not listed in the catalog or in the course_admin role's permission list.
  5. Verify nothing changed for access. A user with the course_admin role still passes the courses.manage_taxonomies permission check, and the other course roles still pass the same checks as before.

Deadline

Willow

Other Information

  • Category IDs are removed or renamed: course_information and course_other are deleted, and course_cohorts, course_team_group, and course_grading become course_cohorts_content_groups, course_team, and course_grading_settings. When the schema is applied, the old categories are pruned, and the permissions are re-linked to the new ones, so no data migration is needed. Nothing in this repository references the old IDs, but consumers that read category IDs from the catalog API (such as the Roles and Permissions console frontend) must use the new ones.
  • Display names and descriptions change, so consumers that match on them instead of on IDs will see different strings.

@BryanttV
BryanttV added this pull request to stack #635 November 17, 2026 17:31
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 17, 2026
@openedx-webhooks

openedx-webhooks commented Nov 17, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/committers-openedx-authz.

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 Nov 17, 2026
@BryanttV
BryanttV force-pushed the bav/update-course-roles-permissions-matrix branch from 48b0920 to c4de3ce Compare November 17, 2026 17:34
@BryanttV
BryanttV force-pushed the bav/update-course-roles-permissions-matrix branch 3 times, most recently from 5d546a8 to 36e67a8 Compare November 18, 2026 02:13
@BryanttV
BryanttV marked this pull request as ready for review November 18, 2026 02:16

@mariajgrimaldi mariajgrimaldi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@BryanttV
BryanttV force-pushed the bav/update-course-roles-permissions-matrix branch 2 times, most recently from 20004c8 to 9688e7f Compare November 18, 2026 15:40
Align course categories and permissions with the product proposal for the
Roles and Permissions console: move View course info, View checklists,
Export tags and the group configuration permissions to their new groups,
remove the empty course_information and course_other categories, rename
and re-describe groups, and hide manage_taxonomies. Role grants and
permission checks are unchanged.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@BryanttV
BryanttV force-pushed the bav/update-course-roles-permissions-matrix branch from 9688e7f to fa49f50 Compare November 18, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants