refactor: use default for samples over generic type #582
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
erunion
added
enhancement
erunion
approved these changes
Jan 22, 2022
julshotal
deleted the
refactor/use-default-in-responses-if-no-example-rm-3096
branch
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
When there's no example present, right now we just autofill the example sample with the type. This will use the default if it exists before falling back to a generic type-based sample
I used how we were taking the default for booleans over a generic value and turned it into a reusable function to either use the default if it 1) exists and 2) is the right type, otherwise it falls back onto a provided generic value
The type check probably isn't super necessary, but on the off chance someone tries to use a wacky default hopefully it'll prevent something from breaking
🧬 QA & Testing
see tests