Encapsulate child entity + entity versions in Containers API [FC-0083] #300
Conversation
instead of passing two separate publishable_entities_pks + entity_version_pks lists as arguments. ContainerEntityRow encapsulates the entity.pk + (optional) entity version.pk in a single structure.
|
Thanks for the pull request, @pomegranited! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
There was a problem hiding this comment.
LGTM 👍
Thank you for your work, @pomegranited!
- I tested this using the instructions from the PR
- I read through the code
- I checked for accessibility issues
- Includes documentation
when adding/updating container children
instead of in loop
5 participants
This PR addresses #278 (comment) by creating a dataclass that encapsulates a PublishableEntity.pk with an optional PublishableEntityVersion.pk, so that the container API methods don't have to pass in two separate lists when specifying pinned versions for a container's children.
This change only affects the (unstable) publishing app's container-related API. The (also unstable) Units API, which is used by edx-platform, remains unchanged.
Testing instructions
A careful code review + passing CI should be sufficient for testing this change.
Private-ref: FAL-4120