Repository navigation
fix(typescript-fetch): optional nullable fields return null instead of undefined - #24215
Merged
Merged
Conversation
…f undefined When an optional field is marked as nullable in the spec, FromJSONTyped now returns null (not undefined) when the API returns null. Non-nullable optional fields continue to return undefined as before. Fixes OpenAPITools#5670
6 tasks done
Contributor
There was a problem hiding this comment.
4 issues found across 17 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Contributor
Author
Thanks for the quick review! Looking forward to seeing this in the next release 🙌 |
Member
|
@mstojanovic8 thanks for the PR can you please review the build failure when you've time? let us know if you need help updating the samples |
…f undefined Use strict equality (===) to distinguish between absent fields (undefined) and explicitly null fields. When an optional nullable field is absent from the JSON response, it returns undefined. When it is explicitly null, it returns null instead of undefined. Fixes OpenAPITools#5670
3 tasks done
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
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.
When an optional field is marked as nullable in the spec, FromJSONTyped now returns null (not undefined) when the API returns null. Non-nullable optional fields continue to return undefined as before.
Fixes #5670
PR checklist
./bin/generate-samples.sh ./bin/configs/typescript-fetch*Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
cc @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha @dennisameling
Summary by cubic
Make
typescript-fetchmodels return null for optional nullable fields when the API sends null, and undefined when the field is missing. Non-nullable optionals are unchanged. Fixes #5670.Bug Fixes
=== undefined/=== null) inmodelGeneric.mustachesoFromJSONTypeddistinguishes missing vs explicit null across primitives, dates, arrays/sets, maps, free-form objects, and object refs.testOptionalNullableFieldDeserializesToNullwithnullable_property.json; regeneratedpetstoretypescript-fetchsamples.samples/server/petstore/jaxrs-spec-enum/pom.xmlto JUnit 5 (org.junit.jupiter) andmaven-surefire-plugin/maven-failsafe-plugin3.5.6 for reliable test runs.Migration
Written for commit 1196727. Summary will update on new commits.