fix(schema): include type field when nullable is used with allOf#3784
Open
maruthang wants to merge 1 commit intonestjs:masterfrom
Open
fix(schema): include type field when nullable is used with allOf#3784maruthang wants to merge 1 commit intonestjs:masterfrom
maruthang wants to merge 1 commit intonestjs:masterfrom
Conversation
When a property is nullable with a $ref (e.g. UserDto | null), the schema had nullable: true and allOf but no type field. This caused Redocly lint errors since OpenAPI 3.0 requires type when nullable is present. Now preserves type: 'object' for nullable properties with schema combinators. Closes nestjs#3274
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
1 participant
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.
PR Checklist
PR Type
What is the current behavior?
When a property is
UserDto | null, the schema hasnullable: trueandallOf: [{ $ref }]but notypefield. Redocly's linter errors: "The type field must be defined when the nullable field is used."Issue Number: #3274
What is the new behavior?
Preserves
type: 'object'for nullable properties with schema combinators. TheextractPropertiesFromTypecombinator handler now keepstypewhennullable: true.Does this PR introduce a breaking change?