Skip resolving in #/components/examples #977
Merged
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
drwpow
force-pushed
the
octokit
branch
2 times, most recently
from
5b7c163 to
ea6541c
Compare
wolfy1339
reviewed
Nov 10, 2022
|
@wolfy1339 I added the schema that was breaking in your CI error. Not sure if it would be helpful to have other schemas here to test just to make sure they’re generating as expected. Would happily accept PRs adding any you’d like to. |
drwpow
changed the title
|
Released in |
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.
Changes
Fixes #975.
$refs in#/components/exampleswere trying to be parsed as valid OpenAPI schema objects which are not.This is a quick fix to simply ignore example objects because they can be rather lengthy and have no expected type generation. Open to suggestions on improvements to adding examples if there’s a good way to do so without generating comments thousands of lines long.
How to Review
Checklist
examples/directory updated (if applicable)