Skip to content

feat: endpoint to get PDF settings#193

Open
Kelketek wants to merge 2 commits intoopenedx:mainfrom
open-craft:fox/pdf-struct-return
Open

feat: endpoint to get PDF settings#193
Kelketek wants to merge 2 commits intoopenedx:mainfrom
open-craft:fox/pdf-struct-return

Conversation

@Kelketek
Copy link
Contributor

Description

This merge request adds a JSON-based endpoint for fetching the PDF Block's settings. This allows for react-based processing of the data without requiring parsing of XML, and allows the fields to be returned alongside system-specific settings for the block (such as the global download disable flag.)

This will be used in frontend-authoring to fetch the current block settings before presenting an editing form.

Supporting information

In-progress PR for authoring changes: openedx/frontend-app-authoring#2916

In-progress PR for platform changes: openedx/openedx-platform#38148

Testing instructions

Switch to the platform branch in your tutor development environment. Note you may need to follow instructions here due to the recent switch to pyproject.toml.

Next, set up frontend-app-authoring for development, and use the in-progress authoring branch.

Add "pdf" to the list of advanced modules. Add a PDF, modify its settings, and save it. Then edit the block after it appears to verify its settings are present. Refresh to be sure.

Deadline

As soon as is practical.

Other information

The other PRs do not need to be merged for this one to be merged.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Mar 12, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @Kelketek!

This repository is currently maintained by @openedx/axim-engineering.

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.

@mphilbrick211
Copy link

@openedx/axim-engineering would someone be able to please take a look at this?

Copy link

@samuelallan72 samuelallan72 left a comment

Choose a reason for hiding this comment

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

@Kelketek 👍

  • I tested this: followed testing instructions
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

def student_view(self, context=None):
"""Primary view of the XBlock, shown to students when viewing courses."""
context = {
@property

Choose a reason for hiding this comment

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

I'm not a fan of using the property decorator unless absolutely necessary, as it hides a function call. Just a nit though; address at your discretion.

@feanil feanil requested a review from a team March 13, 2026 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants