Skip to content

fix: Delete index when delete container & Restore container API added [FC-0083] #36464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
bradenmacdonald merged 11 commits into from
Apr 10, 2025
Merged

fix: Delete index when delete container & Restore container API added [FC-0083] #36464

bradenmacdonald merged 11 commits into from
Apr 10, 2025

Conversation

@ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Apr 2, 2025 •
edited
Loading

Description

  • Delete the search document of the container when deleting the container.
  • Add Restore container API and REST API.
  • Which edX user roles will this change impact? "Course Author", "Developer".

Supporting information

Testing instructions

Deadline

ASAP

Other information

N/A

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

openedx-webhooks commented Apr 2, 2025 •
edited
Loading

Thanks for the pull request, @ChrisChV!

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.

@ChrisChV ChrisChV marked this pull request as draft April 2, 2025 02:18
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 2, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 2, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 2, 2025
@ChrisChV ChrisChV mentioned this pull request Apr 3, 2025
Closed
@ChrisChV ChrisChV changed the title fix: Delete index when delete container [FC-0083] fix: Delete index when delete container & Restore container API added [FC-0083] Apr 8, 2025
@ChrisChV ChrisChV marked this pull request as ready for review April 8, 2025 00:59
@ChrisChV ChrisChV self-assigned this Apr 8, 2025
@ChrisChV ChrisChV mentioned this pull request Apr 8, 2025
Merged
pomegranited
pomegranited approved these changes Apr 8, 2025
View reviewed changes
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Couple of nits and one suggestion -- but this is working well :)

  • I tested this while testing openedx/frontend-app-authoring#1773
  • I read through the code
  • I checked for accessibility issues N/A
  • Updates documentation -- code comments, function docs
  • User-facing strings are extracted for translation N/A

openedx/core/djangoapps/content/search/api.py


def delete_index_doc(usage_key: UsageKey) -> None:
def delete_index_doc(key: OpaqueKey) -> None:
Copy link
Contributor

@pomegranited pomegranited Apr 8, 2025

Choose a reason for hiding this comment

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

Thank you for fixing these "usage key" references!

rpenido
rpenido approved these changes Apr 9, 2025
View reviewed changes
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thank you for your work, @ChrisChV! And thanks for fixing the UsageKey types!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@rpenido rpenido mentioned this pull request Apr 9, 2025
Merged
@bradenmacdonald bradenmacdonald merged commit dc4144e into openedx:master Apr 10, 2025
49 checks passed
@bradenmacdonald bradenmacdonald deleted the chris/FAL-4066-delete-unit branch April 10, 2025 22:15
@github-project-automation github-project-automation bot moved this from Waiting on Author to Done in Contributions Apr 10, 2025
@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Apr 10, 2025

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

@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Apr 11, 2025

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

farhan pushed a commit that referenced this pull request Apr 17, 2025
@ChrisChV @farhan
feat: add restore container API, delete index when deleting container (…
bedcee5 
…#36464)
@ormsbee ormsbee mentioned this pull request Apr 23, 2025
Merged
tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
@ChrisChV @tonybusa
feat: add restore container API, delete index when deleting container (…
3c4d0a1 
…openedx#36464)
UsamaSadiq pushed a commit that referenced this pull request May 14, 2025
@ChrisChV @UsamaSadiq
feat: add restore container API, delete index when deleting container (…
408df13 
…#36464)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pomegranited pomegranited pomegranited approved these changes

+1 more reviewer

@rpenido rpenido rpenido approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ChrisChV ChrisChV

Labels

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

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@ChrisChV @openedx-webhooks @edx-pipeline-bot @rpenido @pomegranited @bradenmacdonald @mphilbrick211