feat: output openapi.json in static build#71
Open
jeremy-code wants to merge 1 commit into
Open
Conversation
- Output openapi.json in static build with @redocly/cli bundle - Update docs download button to link to /openapi.json instead of blob URL
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
1 participant
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 / Why
Consumers of the npm Registry API may need programmatic access to the openapi.json schema via a URL instead of a download button. It will also allow consumers to receive updates whenever the schema changes.
Currently, the download button links to a blob URL instead of hosting the openapi.json schema directly.
Describe the request in detail. What it does and why it's being changed.
The
openapi.jsonis generated inhtml/in the build script withnpx @redocly/cli bundle openapi.yaml --output html/openapi.json.I added --theme.openapi to the
build-docscommand, so that it links to the hosted static file instead of a blob URL.