Skip to content
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

refactor: Update get block OLX view to support versions [FC-0062] #35932

Merged
merged 10 commits into from
Dec 5, 2024
Merged

refactor: Update get block OLX view to support versions [FC-0062] #35932

merged 10 commits into from
Dec 5, 2024

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Nov 27, 2024 •
edited
Loading

Description

  • Deprecate get_block_draft_olx
  • Deprecate get olx view in content libraries
  • Create get_block_olx in xblock API with support of versions
  • Create get olx view in xblock

Supporting information

Testing instructions

Deadline

ASAP

@openedx-webhooks
Copy link

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX to support versions refactor: Update Get block OLX to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX to support versions [FC-0062] refactor: Update Get block OLX view to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX view to support versions [FC-0062] refactor: Update get block OLX view to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV mentioned this pull request Nov 27, 2024
Merged
bradenmacdonald
bradenmacdonald requested changes Nov 27, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

I think this works, but I have a bunch of refactoring suggestions to make this more consistent and make our APIs even better.

openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/xblock/api.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/xblock/api.py Show resolved Hide resolved
openedx/core/djangoapps/content_libraries/views.py Outdated Show resolved Hide resolved
bradenmacdonald
bradenmacdonald reviewed Nov 29, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Looking good. Just some minor suggestions, and then we'll need tests for the new APIs.

openedx/core/djangoapps/xblock/rest_api/urls.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/xblock/utils.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/xblock/rest_api/views.py Show resolved Hide resolved
openedx/core/djangoapps/content_libraries/views.py Outdated Show resolved Hide resolved
@ChrisChV
Copy link
Contributor Author

ChrisChV commented Dec 2, 2024

@bradenmacdonald It's ready for another review

bradenmacdonald
bradenmacdonald approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

👍 Looks good. Thanks for making those changes! Please just remove this unused function (if it is unused) before merging.

  • I tested this
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

openedx/core/djangoapps/xblock/api.py Outdated Show resolved Hide resolved
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 2, 2024
@ChrisChV ChrisChV enabled auto-merge (squash) December 5, 2024 18:08
@ChrisChV ChrisChV merged commit 0bd0e6f into openedx:master Dec 5, 2024
48 checks passed
@ChrisChV ChrisChV deleted the chris/FAL-3976-add-version-to-get-block-olx branch December 5, 2024 18:49
ChrisChV added a commit to open-craft/edx-platform that referenced this pull request Dec 5, 2024
@ChrisChV
refactor: Update get block OLX view to support versions [FC-0062] (op…
b31344b 
…enedx#35932)

* Deprecate `get_block_draft_olx`
* Deprecate get olx view in content libraries
* Create `get_block_olx` in xblock API with support of versions
* Create get olx view in xblock
@ChrisChV ChrisChV mentioned this pull request Dec 5, 2024
Merged
@edx-pipeline-bot
Copy link
Contributor

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

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been rolled back from the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been rolled back from the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

bradenmacdonald pushed a commit that referenced this pull request Dec 6, 2024
@ChrisChV
refactor: Update get block OLX view to support versions (backport) (#…
9b96b6f 
…35932) (#35973)
@feanil feanil mentioned this pull request Dec 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ChrisChV @openedx-webhooks @edx-pipeline-bot @bradenmacdonald @mphilbrick211