Skip to content

feat: add platform-level glob scope for content libraries#333

Merged
MaferMazu merged 4 commits into
openedx:mainfrom
eduNEXT:bav/platform-glob-library-scope
Jun 10, 2026
Merged

feat: add platform-level glob scope for content libraries#333
MaferMazu merged 4 commits into
openedx:mainfrom
eduNEXT:bav/platform-glob-library-scope

Conversation

@BryanttV

@BryanttV BryanttV commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Resolves: #307

Description

Add PlatformContentLibraryGlobData, a platform-level glob scope for content libraries, completing the library counterpart to the existing PlatformCourseOverviewGlobData

Example scope keys

Pattern Type Meaning
lib:* Platform glob All libraries on the platform
lib:OpenedX:* Org glob All libraries in org OpenedX
lib:OpenedX:Demo Concrete Single library

Related PR

Testing Instructions

To test these changes, you can check the REST API.

  1. Use the /api/authz/v1/roles/users/ endpoint to add platform content library permissions:

    {
        "users": ["john"],
        "role": "library_admin",
        "scopes": ["lib:*"]
    }
  2. Validate the permissions /api/authz/v1/permissions/validate/me

    [
        {
            "action": "content_libraries.view_library",
            "scope": "lib:OpenedX:CSPROB"
        },
        {
            "action": "content_libraries.manage_library_team",
            "scope": "lib:OpenedX:CSPROB2"
        },
        {
            "action": "content_libraries.edit_library_collection",
            "scope": "lib:any-org:any-slug"
        }
    ]

Response

[
    {
        "action": "content_libraries.view_library",
        "scope": "lib:OpenedX:CSPROB",
        "allowed": true
    },
    {
        "action": "content_libraries.manage_library_team",
        "scope": "lib:OpenedX:CSPROB2",
        "allowed": true
    },
    {
        "action": "content_libraries.edit_library_collection",
        "scope": "lib:any-org:any-slug",
        "allowed": true
    }
]

Merge checklist

Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

BryanttV and others added 2 commits June 8, 2026 18:06
@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 Jun 9, 2026
@openedx-webhooks

openedx-webhooks commented Jun 9, 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.

@BryanttV BryanttV force-pushed the bav/platform-glob-library-scope branch from a79d214 to 8ba4bc3 Compare June 9, 2026 17:44
@BryanttV BryanttV requested review from MaferMazu and bmtcril June 9, 2026 17:47
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 10, 2026

@MaferMazu MaferMazu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Thanks for this PR @BryanttV.

The code looks good. I ran some tests, and everything is working fine. I just have a suggestion: can we add a case to test_enforcement "for a user who manages lib teams globally -> it can assign globally"? I tested manually and worked as expected, but it would be good to have it in the unit test.

@bmtcril bmtcril left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me, nothing to add to @MaferMazu 's review. I can thumb once the test is added.

@BryanttV

Copy link
Copy Markdown
Contributor Author

Thank you both very much! I just updated the tests according to the suggestion.

@MaferMazu MaferMazu merged commit 0041ac3 into openedx:main Jun 10, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Jun 10, 2026
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: Done

Development

Successfully merging this pull request may close these issues.

GAP global scope libraries

5 participants