Skip to content

Conversation

@luisfelipec95
Copy link

Description

This PR enhances the synchronization process of badge templates from the Credly API by implementing pagination support.

Previously, the fetch_badge_templates function only retrieved the first page of results (up to 50 templates).
Now, the function iterates through all available pages to fetch every active badge template, ensuring no data is missed during synchronization.

Supporting information

  • No migrations; no operator action required for default deployments.

Testing instructions

  • Executed sync_organization_badge_templates for an organization with more than 50 templates.
  • Confirmed that the total number of local records matches the total returned by the API.

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

Thanks for the pull request, @luisfelipec95!

This repository is currently maintained by @2U-aperture.

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.


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.

@e0d
Copy link

e0d commented Nov 14, 2025

@luisfelipec95 Thanks for this. It looks like some of the tests are failing, can you have a look?

# For each iteration, fetch data using the 'next_page_url' provided by the API,
# append the results to the main list, and update the URL for the next request.
# The loop stops when there are no more pages to retrieve.
for _ in range(2, total_pages + 1):
Copy link

Choose a reason for hiding this comment

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

A few robustness questions:

  1. What's a reasonable maximum number of pages?
  2. What happens if you hit a rate limit or timeout?
  3. should you throttle the calls to not be flagged as a bot or overwhelm the backend?
  4. Is this ever called from a request to the credentials frontend?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: No status
Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants