#1391: add generated doc cleaning script #2077
Merged
Conversation
This file contains 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
## What The cleaning script replaces all references to the Unleash ushosted instance in the generated OpenAPI docs. It removes extra path segments (such as leading `/ushosted` instances) and replaces the ushosted base url with something user-agnostic. ## Why When we host the OpenAPI docs in our official documentation, the generated docs shouldn't necessarily point at _one specific instance_, and especially not one that the reader is unlikely to ever use. Instead, we can remove all the bits that are specific to the generation source we use, and make the docs easier to use. In particular, removing the leading `/ushosted` is likely to save us loooots of questions.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Using NODE_ENV=development doesn't necessarily make sense, so adding an extra variable sounds reasonable to me.
Coverage report
Test suite run success1160 tests passing in 191 suites. Report generated by 🧪jest coverage report action from e1dfcde |
In the event that we change the base URL of OpenAPI, so that paths don't start with `/ushosted/`, the script should still work, changing those paths into <your-unleash-url> too. Additionally, remove all instances of `/ushosted` that we find. In the event that some things switch around or whatever.
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.
What
The cleaning script replaces all references to the Unleash ushosted instance in the generated OpenAPI docs. It removes extra path segments (such as leading
/ushostedinstances) and replaces the ushosted base url with something user-agnostic.Why
When we host the OpenAPI docs in our official documentation, the generated docs shouldn't necessarily point at one specific instance, and especially not one that the reader is unlikely to ever use. Instead, we can remove all the bits that are specific to the generation source we use, and make the docs easier to use. In particular, removing the leading
/ushostedis likely to save us loooots of questions.How
By adding a new dev dependency (
replace-in-file) and running the script after doc generation.Bonus changes
This PR also changes which environment variable controls whether you're pointing at a local API or the ushosted api.