Basic CRUD REST Endpoints for units in content libraries [FC-0083] #36371

bradenmacdonald · 2025-03-12T23:51:43Z

Description

Implements openedx/frontend-app-authoring#1703

This PR adds python and REST APIs for creating Units in content libraries.

Supporting information

Depends on:

feat: Create LibraryContainerLocator for Library Containers [FC-0083] opaque-keys#369
feat: adds get_containers and get_container_by_key to the authoring API [FC-0083] openedx-learning#287
feat: adds events related to content library containers [FC-0083] openedx-events#479

Includes commits from:

refactor: convert content libraries python API from attr.s to dataclass, fix types [FC-0083] #36381 (once it merges, this PR can be rebased to drop those changes)

Testing instructions

Set up the dependency PRs in your devstack/python environment.
- Tip: if you add opaque-keys to this list in tutor (we should upstream that fix), you can just run tutor mounts add opaque-keys, then from within your cms container make sure to run pip install -e /mnt/opaque-keys after checking out the correct branch, to refresh the entry points.
Run tests.
- tutor dev exec cms bash
- DJANGO_SETTINGS_MODULE=cms.envs.tutor.test pytest openedx/core/djangoapps/content_libraries/ openedx/core/djangoapps/content/search/tests/ -x

Status

Out of scope for now:

Update and Delete will be done in a follow-up PR: feat: adds APIs to update or delete a container open-craft/edx-platform#757
Anything involving children / components in the unit.

Deadline

ASAP

Private ref: FAL-4052

openedx-webhooks · 2025-03-12T23:51:46Z

Thanks for the pull request, @bradenmacdonald!

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.

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.

openedx/core/djangoapps/content_libraries/rest_api/serializers.py

pomegranited · 2025-03-26T11:30:41Z

Hi @kdmccormick and @ormsbee -- could you have another look at this PR to see if I've addressed your concerns here?

kdmccormick

Not a thorough review, but my concern is resolved, so 👍🏻

If you want me to test and review thoroughly, let me know and I can do that!

openedx/core/djangoapps/content/search/tests/test_api.py

pomegranited · 2025-03-27T00:23:20Z

Thanks @kdmccormick ! cf e0f4380

If you want me to test and review thoroughly, let me know and I can do that!

I'm happy with @rpenido and @navinkarkera 's reviews, but thank you for offering. I've got some follow-up work to do here in later PRs though, so if there's anything bugging you, please let me know :)

ormsbee · 2025-03-27T18:32:42Z

@pomegranited: I'm good with trusting your existing reviewers on this. Thank you.

* feat: adds python and REST APIs to update a container's display_name * refactor: adds _get_container method to api to reduce code duplication * feat: adds python and REST APIs to delete a container * test: add container permission tests

edx-pipeline-bot · 2025-03-28T15:50:34Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-03-28T16:07:53Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-03-28T16:07:54Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-03-28T16:26:44Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-03-28T16:42:59Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-03-28T16:42:59Z

2U Release Notice: This PR has been deployed to the edX production environment.

Addresses libraries API TODOs introduced by #36371

…36371) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code * feat: use new version of openedx-learning with containers support * temp: Use opencraft branch of opaquekeys * refactor: Use LibraryElementKey instead of LibraryCollectionKey * refactor: split libraries API & REST API up into smaller modules * feat: new REST API for units in content libraries * feat: python+REST API to get a unit * feat: auto-generate slug/key/ID from title of units * feat: generate search index documents for containers * refactor: rename LibraryElementKey to LibraryItemKey * fix: lint error * feat: adds new units to search index on create/update and when running reindex_studio. Updates requirements for openedx-events and openedx-learning to support these changes. * fix: pylint * fix: temp requirement * fix: search index container events/tasks * feat: add get_library_container_usage_key to libraries API and use it when search indexing containers * fix: index all containers during reindex_studio * chore: bump openedx-events requirement * fix: address review comments * chore: bumps openedx-learning to 0.19.1 * fix: rename api method to library_container_locator since container keys are locators, not usage keys * chore: bumps opaque-keys dependency * test: fix misnamed unit_usage_key * feat: adds APIs to update or delete a container (#757) * feat: adds python and REST APIs to update a container's display_name * refactor: adds _get_container method to api to reduce code duplication * feat: adds python and REST APIs to delete a container * test: add container permission tests --------- Co-authored-by: XnpioChV <xnpiochv@gmail.com> Co-authored-by: Jillian Vogel <jill@opencraft.com> Co-authored-by: Rômulo Penido <romulo.penido@gmail.com>

Addresses libraries API TODOs introduced by #36371

…penedx#36371) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code * feat: use new version of openedx-learning with containers support * temp: Use opencraft branch of opaquekeys * refactor: Use LibraryElementKey instead of LibraryCollectionKey * refactor: split libraries API & REST API up into smaller modules * feat: new REST API for units in content libraries * feat: python+REST API to get a unit * feat: auto-generate slug/key/ID from title of units * feat: generate search index documents for containers * refactor: rename LibraryElementKey to LibraryItemKey * fix: lint error * feat: adds new units to search index on create/update and when running reindex_studio. Updates requirements for openedx-events and openedx-learning to support these changes. * fix: pylint * fix: temp requirement * fix: search index container events/tasks * feat: add get_library_container_usage_key to libraries API and use it when search indexing containers * fix: index all containers during reindex_studio * chore: bump openedx-events requirement * fix: address review comments * chore: bumps openedx-learning to 0.19.1 * fix: rename api method to library_container_locator since container keys are locators, not usage keys * chore: bumps opaque-keys dependency * test: fix misnamed unit_usage_key * feat: adds APIs to update or delete a container (openedx#757) * feat: adds python and REST APIs to update a container's display_name * refactor: adds _get_container method to api to reduce code duplication * feat: adds python and REST APIs to delete a container * test: add container permission tests --------- Co-authored-by: XnpioChV <xnpiochv@gmail.com> Co-authored-by: Jillian Vogel <jill@opencraft.com> Co-authored-by: Rômulo Penido <romulo.penido@gmail.com>

Addresses libraries API TODOs introduced by openedx#36371

…36371) * refactor: convert libraries API from attr.s to dataclass, fix types * fix: make corresponding updates to 'search' code * feat: use new version of openedx-learning with containers support * temp: Use opencraft branch of opaquekeys * refactor: Use LibraryElementKey instead of LibraryCollectionKey * refactor: split libraries API & REST API up into smaller modules * feat: new REST API for units in content libraries * feat: python+REST API to get a unit * feat: auto-generate slug/key/ID from title of units * feat: generate search index documents for containers * refactor: rename LibraryElementKey to LibraryItemKey * fix: lint error * feat: adds new units to search index on create/update and when running reindex_studio. Updates requirements for openedx-events and openedx-learning to support these changes. * fix: pylint * fix: temp requirement * fix: search index container events/tasks * feat: add get_library_container_usage_key to libraries API and use it when search indexing containers * fix: index all containers during reindex_studio * chore: bump openedx-events requirement * fix: address review comments * chore: bumps openedx-learning to 0.19.1 * fix: rename api method to library_container_locator since container keys are locators, not usage keys * chore: bumps opaque-keys dependency * test: fix misnamed unit_usage_key * feat: adds APIs to update or delete a container (#757) * feat: adds python and REST APIs to update a container's display_name * refactor: adds _get_container method to api to reduce code duplication * feat: adds python and REST APIs to delete a container * test: add container permission tests --------- Co-authored-by: XnpioChV <xnpiochv@gmail.com> Co-authored-by: Jillian Vogel <jill@opencraft.com> Co-authored-by: Rômulo Penido <romulo.penido@gmail.com>

Addresses libraries API TODOs introduced by #36371

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 12, 2025

openedx-webhooks added this to Contributions Mar 12, 2025

github-project-automation bot moved this to Needs Triage in Contributions Mar 12, 2025

bradenmacdonald mentioned this pull request Mar 12, 2025

Backend: Basic CRUD REST Endpoint for units in libraries openedx/frontend-app-authoring#1703

Closed

refactor: convert libraries API from attr.s to dataclass, fix types

6f86848

bradenmacdonald force-pushed the braden/units-api branch 4 times, most recently from de946eb to 55d9b34 Compare March 14, 2025 02:21

This was referenced Mar 14, 2025

feat: get_library_unit_usage_key in new content_libraries.units module [FC-0083] #36379

Closed

refactor: convert content libraries python API from attr.s to dataclass, fix types [FC-0083] #36381

Merged

bradenmacdonald force-pushed the braden/units-api branch from 55d9b34 to bce12f4 Compare March 14, 2025 02:35

fix: make corresponding updates to 'search' code

0508e3b

bradenmacdonald force-pushed the braden/units-api branch from bce12f4 to a5fa375 Compare March 14, 2025 06:15

bradenmacdonald and others added 3 commits March 14, 2025 09:45

feat: use new version of openedx-learning with containers support

88ba74f

temp: Use opencraft branch of opaquekeys

144ff01

refactor: Use LibraryElementKey instead of LibraryCollectionKey

d125b04

bradenmacdonald force-pushed the braden/units-api branch 5 times, most recently from 40f8988 to ec7c500 Compare March 14, 2025 22:09

bradenmacdonald added 2 commits March 14, 2025 15:34

refactor: split libraries API & REST API up into smaller modules

0b8e12c

feat: new REST API for units in content libraries

9383d5f

bradenmacdonald force-pushed the braden/units-api branch from ec7c500 to 9383d5f Compare March 14, 2025 22:34

bradenmacdonald added 2 commits March 14, 2025 15:38

feat: python+REST API to get a unit

60169db

feat: auto-generate slug/key/ID from title of units

6a9a916

rpenido reviewed Mar 14, 2025

View reviewed changes

openedx/core/djangoapps/content_libraries/rest_api/serializers.py Outdated Show resolved Hide resolved

feat: generate search index documents for containers

0352559

pomegranited force-pushed the braden/units-api branch from ba75452 to 2cd7532 Compare March 24, 2025 04:40

navinkarkera mentioned this pull request Mar 24, 2025

feat: api for adding, removing and updating components in container #36434

Merged

Merge remote-tracking branch 'origin/master' into braden/units-api

6cb8125

ChrisChV mentioned this pull request Mar 26, 2025

feat: Update containers in search index on components update/delete [FC-0083] #36432

Merged

Merge remote-tracking branch 'origin/master' into braden/units-api

0370a37

pomegranited mentioned this pull request Mar 26, 2025

feat: adds APIs to update or delete a container open-craft/edx-platform#757

Merged

kdmccormick approved these changes Mar 26, 2025

View reviewed changes

openedx/core/djangoapps/content/search/tests/test_api.py Outdated Show resolved Hide resolved

test: fix misnamed unit_usage_key

e0f4380

pomegranited mentioned this pull request Mar 27, 2025

Finishes refactoring libraries APIs open-craft/edx-platform#758

Closed

pomegranited added 2 commits March 28, 2025 10:16

Merge remote-tracking branch 'origin/master' into braden/units-api

6686902

navinkarkera merged commit 1ca57ec into openedx:master Mar 28, 2025
49 checks passed

github-project-automation bot moved this from In Eng Review to Done in Contributions Mar 28, 2025

pomegranited mentioned this pull request Apr 3, 2025

Finishes refactoring libraries APIs [FC-0083] #36468

Merged

ChrisChV pushed a commit that referenced this pull request Apr 7, 2025

Finishes refactoring libraries APIs [FC-0083] (#36468)

94468ef

Addresses libraries API TODOs introduced by #36371

irtazaakram pushed a commit that referenced this pull request Apr 10, 2025

Finishes refactoring libraries APIs [FC-0083] (#36468)

13cdee1

Addresses libraries API TODOs introduced by #36371

tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025

Finishes refactoring libraries APIs [FC-0083] (openedx#36468)

09b96d2

Addresses libraries API TODOs introduced by openedx#36371

UsamaSadiq pushed a commit that referenced this pull request May 14, 2025

Finishes refactoring libraries APIs [FC-0083] (#36468)

339a4fc

Addresses libraries API TODOs introduced by #36371

Basic CRUD REST Endpoints for units in content libraries [FC-0083] #36371

Basic CRUD REST Endpoints for units in content libraries [FC-0083] #36371

Uh oh!

Conversation

bradenmacdonald commented Mar 12, 2025 • edited by pomegranited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Status

Deadline

Uh oh!

openedx-webhooks commented Mar 12, 2025

Uh oh!

Uh oh!

pomegranited commented Mar 26, 2025

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pomegranited commented Mar 27, 2025

Uh oh!

ormsbee commented Mar 27, 2025

Uh oh!

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

edx-pipeline-bot commented Mar 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

bradenmacdonald commented Mar 12, 2025 •

edited by pomegranited

Loading