Closed alvinometric closed 1 week ago
The latest updates on your projects. Learn more about Vercel for Git ↗︎
Name | Status | Preview | Comments | Updated (UTC) |
---|---|---|---|---|
unleash-docs | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Nov 12, 2024 5:05pm |
unleash-monorepo-frontend | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Nov 12, 2024 5:05pm |
✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.
Package | Version | Score | Details |
---|
Problem
Our API docs are generated from a specfile that is hosted in https://us.app.unleash-hosted.com/ushosted
By default the API docs UI will show that URL, which we don't want
Previously
We ran a find-and-replace after the mdx files were generated with
replace-in-file
Now
The previous solution is no longer possible because the openapi plugin changed. Basically, before it generated markdown files that looked like this:
Now it generates files that do not contain the URL and look like this:
which themselves get compiled.
Solution
This PR now downloads the specfile, makes a local copy, then an alters the server URL in the copy, then uses that local file to generate the docs.
I didn't want to make any changes to the actual spec logic because this essentially just a plugin quirk
PREVIEW LINK