fix: convert nullable and keep examples for OpenAPI 3.1+ - #955
Merged
Merged
Conversation
gurgunday
approved these changes
Sep 23, 2026
Member
|
LGTM, let's wait for one more review though |
Eomm
approved these changes
Sep 24, 2026
Signed-off-by: Antonio Tripodi <Tony133@users.noreply.github.com>
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.
Proposal:
Fixes #954
OpenAPI 3.1 uses JSON Schema 2020-12, where
nullabledoes not exist andexamplesis an array keyword. When generating a 3.1+ document, the plugin passednullable: truethrough unchanged (so nullability was silently lost by 3.1 readers) and downgradedexamplestoexample, dropping every example after the first.This is the symmetric conversion of #889, which handles the opposite direction (
type: ['string', 'null']→nullable: truefor 3.0).Changes (OpenAPI 3.1+ only):
nullable: trueis converted totype: [..., 'null']. As in OpenAPI 3.0, it only applies to an explicittype; without one it is dropped (Ajv refuses to compile such schemas anyway).enumis deliberately left untouched: Ajv only acceptsnullifenumlists it explicitly, and so does JSON Schema. Addingnullto the enum would describe a value the validator rejects.examplesarrays are kept in nested Schema Objects instead of being downgraded toexample. The top-level media schema still movesexamplesto the Media Type Object, which is valid in 3.1 and is what Swagger UI displays.typeis an array (e.g.['object', 'null']); before, the examples resolution stopped at such schemas.OpenAPI 3.0 output is unchanged.
Note:
convertJsonSchemaToOpenapi3recurses into every value, including data such asdefaultandx-*objects. Anullablekey inside those would be touched, exactly astypealready is on the 3.0 branch. This is a pre-existing limitation of the converter and should be handled separately.