Add generateSchemas option #1203
Open
Conversation
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
This works similar to showSchemas but it doesn't add the schemas to the sidebar. This is useful to generate the schemas and then embed them in other pages as needed.
|
Visit the preview URL for this PR (updated for commit 83cac31): https://docusaurus-openapi-36b86--pr1203-q5qw1vc0.web.app (expires Sat, 16 Aug 2025 19:02:03 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
|
Hi @lukedirtwalker, thanks for the PR! Do you think this feature/option could be better suited as a CLI command/arg? Something like: |
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.
This works similar to showSchemas but it doesn't add the schemas to the sidebar. This is useful to generate the schemas and then embed them in other pages as needed.
Description
This changes introduces a new configuration option
generateSchemas, to generate openAPI schemas, while not including them in the sidebar.Motivation and Context
If you have a lot Schema and only selectively want to import the schemas in other pages this is helpful.
How Has This Been Tested?
I manually patched the dependency, set the generateSchemas to true and checked that they were generated.
Types of changes
Checklist