Conversation
This branch has not been deployed
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.
Context
A nullable primitive branch in an OpenAPI 3.0
oneOflosesnullin the generated TypeScript type. This affects both the separate-model andwithoutRuntimeChecksoutput modes.For example:
The generated declaration is
number | string, although this schema also acceptsnull.Root cause
The
oneOftype-name strings do not retain branch nullability. The corresponding composed-schema properties still contain it.Decision
Count nullable branches from the composed-schema properties and add
nullto the generated type union when exactly one branch is nullable. This fixes the type metadata without a template override or a new generator option.Consequences
Nullable primitive unions include
null. Unions with zero or two nullable primitive branches keep their non-null declaration, consistent with the exactly-one matching rule ofoneOf. Nullable array elements do not make the array itself nullable.cc @joscha
Summary by cubic
Fixes the TypeScript fetch generator so nullable primitive
oneOfbranches preservenullin the generated union type.nullto the union only when exactly one branch is nullable, matching theoneOfsemantics.Written for commit 80e2602. Summary will update on new commits.