DEV-7033 Update ApiDoc component to use swagger-ui-react to fix on Docusaurus 3#9
Open
ryanjcoleman wants to merge 2 commits intomainfrom
Open
DEV-7033 Update ApiDoc component to use swagger-ui-react to fix on Docusaurus 3#9ryanjcoleman wants to merge 2 commits intomainfrom
ryanjcoleman wants to merge 2 commits intomainfrom
Conversation
Member
Author
|
Task linked: DEV-7033 Fix Swagger specs loading in docusaurus |
Signed-off-by: ryanjcoleman <ryan.coleman@zepben.com>
6a21a27 to
aee8e8b
Compare
Signed-off-by: ryanjcoleman <ryan.coleman@zepben.com>
alourie
approved these changes
Feb 5, 2026
Contributor
alourie
left a comment
There was a problem hiding this comment.
LGTM, but I'll wait for @josh-sukheja to give some grades to AI.
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
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.
Description
There's an issue with the recent upgrade to Docusaurus 3, where the embedded swagger API docs don't display at all.
There might be another solution for this, but chatGPT gave me this solution, and it looks to be working when I test locally - please feel free to review/tweak/change this as needed, I don't really know what I'm doing.
Test Steps
Again, might be a better way to test this, but this is how I did it:
npm install react-swagger-uilocally too - normally this will come with the docusaurus-components package, but for now need to manually install separatelyChecklist
Code
I have added/updated unit tests for these changes, and if not I have explained why they are not necessary.I have commented my code in any hard-to-understand or hacky areas.Security
When developing applications, use following guidelines for information security considerations:
Documentation
I have updated the changelog.I have updated any documentation required for these changes.Breaking Changes