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
Allow all types except UNKNOWN to be nullable.
Fixes #1821 and #1940 .
This could be considered a breaking change. Whenever users are processing a request in a server or processing a response in the client, there could be a type error due to the unhandled null case. However, this is a good change because it helps TypeScript prevent bugs.
How to Review
The actual code changes are limited to the end of the transformSchemaObjectWithComposition function in schema-object.ts.
I have added a new test containing the schema in issue #1940 . You can check that this output looks good.
I have also changed the expected values in the various github and digitalocean .ts test files (although they were possibly overwritten by the update:examples script). Wherever I added
| null
to a type, its corresponding schema is nullable. This is something you can double-check, although there are a few hundred cases.Checklist
docs/
updated (if necessary)pnpm run update:examples
run (only applicable for openapi-typescript)