Skip to content

feat: Python api and rest api for History log logic [FC-0123]#38178

Draft
ChrisChV wants to merge 4 commits intoopenedx:masterfrom
open-craft:chris/FAL-4330-history-log
Draft

feat: Python api and rest api for History log logic [FC-0123]#38178
ChrisChV wants to merge 4 commits intoopenedx:masterfrom
open-craft:chris/FAL-4330-history-log

Conversation

@ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Mar 16, 2026

Description

  • Implements python api and REST_API functions to get the history log for a component:
    • get_library_component_draft_history: Return the draft change history for a library component since its last publication.
    • get_library_component_publish_history: Return the publish history of a library component as a list of groups.
    • get_library_component_publish_history_entries: Return the individual draft change entries for a specific publish event.
  • Which edX user roles will this change impact? "Course Author", "Developer".

List of features (TODOs):

  • History log for components:
    • Draft group
    • Publish groups
    • Edge case: Discard changes
  • History log for container:
    • Draft group
    • Publish groups:
      • Container changes groups.
      • Component changes groups.
      • Edge case: Component deleted (?).
    • Edge case: Discard changes.

Supporting information

Testing instructions

Follow the testing instructions in openedx/frontend-app-authoring#2948

Deadline

Before the Verawood cut.

Other information

N/A

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

openedx-webhooks commented Mar 16, 2026

Thanks for the pull request, @ChrisChV!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

@ChrisChV ChrisChV marked this pull request as draft March 16, 2026 23:19
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Mar 16, 2026
@ChrisChV ChrisChV changed the title feat: Python api and rest api for History log logic feat: Python api and rest api for History log logic [FC-0123] Mar 16, 2026
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Mar 23, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants