Skip to content

DEV-7033 Update ApiDoc component to use swagger-ui-react to fix on Docusaurus 3#9

Open
ryanjcoleman wants to merge 2 commits intomainfrom
DEV-7033-Fix-Swagger-specs-loading-in-docusaurus
Open

DEV-7033 Update ApiDoc component to use swagger-ui-react to fix on Docusaurus 3#9
ryanjcoleman wants to merge 2 commits intomainfrom
DEV-7033-Fix-Swagger-specs-loading-in-docusaurus

Conversation

@ryanjcoleman
Copy link
Member

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:

  1. Copy updated ApiDoc folder from here into a docusaurus site with API docs (e.g. ednar-app-server)
  2. Get the site serving locally via NPM, and change the import of the API doc markdown to pull from this local ApiDoc folder instead.
  3. Make sure to run npm install react-swagger-ui locally too - normally this will come with the docusaurus-components package, but for now need to manually install separately
  4. Run docusaurus site and make sure the API specs load okay.

Checklist

Code

  • I have performed a self review of my own code (including checking issues raised when creating the PR).
  • 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.
  • I have handled all new warnings generated by the compiler or IDE.
  • I have rebased onto the target branch (usually main).

Security

When developing applications, use following guidelines for information security considerations:

  • Access to applications should be protected with security keys/tokens or usernames and passwords;
  • All sessions are encrypted if possible;
  • All application input is sanitised before being acted on (ie SQL statements, etc);
  • Log messages, and especially client-facing ones, must be handled securely and must not leak credentials information (internal URLs, passwords, tokens).
  • I have considered if this change impacts information security and made sure those impacts are handled.

Documentation

  • I have updated the changelog.
  • I have updated any documentation required for these changes.

Breaking Changes

  • I have considered if this is a breaking change and will communicate it with other team members by posting it on the Slack breaking-changes channel.

@ryanjcoleman
Copy link
Member Author

Signed-off-by: ryanjcoleman <ryan.coleman@zepben.com>
@ryanjcoleman ryanjcoleman force-pushed the DEV-7033-Fix-Swagger-specs-loading-in-docusaurus branch from 6a21a27 to aee8e8b Compare February 5, 2026 04:01
Signed-off-by: ryanjcoleman <ryan.coleman@zepben.com>
Copy link
Contributor

@alourie alourie left a comment

Choose a reason for hiding this comment

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

LGTM, but I'll wait for @josh-sukheja to give some grades to AI.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments