DOP-5830: Update previews to use Bump #824
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rayangler
commented
Jul 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
With the move to Bump.sh for rendering OpenAPI spec content on the MongoDB docs site, it makes sense to update the preview script to generate previews through Bump as well. Unlike Redoc, Bump doesn't have a client-side way to generate previews (that I know of at the moment), and instead relies on using their API. To avoid needing to make many unnecessary calls to Bump's API, the generated HTML will now create individual temporary Bump preview links on click. A serverless Netlify function maintained by DOP will wrap the calls to Bump's API to minimize CORS issues.
Here's an example of it in action using local dev data:
Screen.Recording.2025-07-21.at.4.52.57.PM.mov
Jira ticket: DOP-5830