Make nullable schemas referenced with $ref generate optional types - #931
Open
k-kohey wants to merge 3 commits into
Open
Make nullable schemas referenced with $ref generate optional types#931k-kohey wants to merge 3 commits into
k-kohey wants to merge 3 commits into
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
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.
Motivation
When a response body schema is referenced with
$ref, the generated type is not optional even if the referenced schema is nullable.Current output:
Expected output:
Writing the same schema inline already produces
...?, so the behavior differs depending on whether$refis used. This also contradicts the documented rule inHandling-nullable-schemas.md: "The nullability of a schema is propagated through references."Modifications
Removed the
.referencebranch inTypeAssigner.typeUsage(usingNamingHint:withSchema:components:inParent:), which resolved the type name without applying nullability. Every schema now goes through_typeUsage, which already applieswithOptional(isOptional(...))to references, so inline and referenced schemas share a single path.Request bodies are unaffected, since
translateRequestBodyexplicitly drops optionality withwithOptional(false).Result
Nullable schemas referenced with
$refare generated as optional types. This covers bothtype: [object, null]andnullable: true, as well as transitive references through another schema. The output for non-nullable references is unchanged.Test Plan
Added tests to
SnippetBasedReferenceTests.