place null last in anyOf for optional unions in JSON schema#1028
Open
SarthakB11 wants to merge 1 commit intojcrist:mainfrom
Open
place null last in anyOf for optional unions in JSON schema#1028SarthakB11 wants to merge 1 commit intojcrist:mainfrom
null last in anyOf for optional unions in JSON schema#1028SarthakB11 wants to merge 1 commit intojcrist:mainfrom
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.
Fixes #1027.
For
T | None,_json_schema.pywas emitting{"type": "null"}beforethe struct/
$refentry inanyOf. Tools that pick the firstanyOfelement for example generation (Swagger UI in the issue) ended up showing
null. Pydantic putsnulllast for the same reason.Move
NoneTypeout of the union iteration into ahas_noneflag andappend
{"type": "null"}last in all three union branches (no-struct,single-struct, tagged-struct). The tagged-struct branch's
if options:guard becomes
if options or has_none:soTagged | Nonekeepsnullin its
anyOfinstead of dropping it.Observable changes:
Struct | None: was[null, $ref], now[$ref, null].Union[X, None, Y]:nullmoves from the middle to the end.str | None: already[string, null]on CPython, unchanged.Tests added in
tests/unit/test_schema.pyforOptional[Struct],Union[int, None, str], andUnion[Tagged, None](covers the thirdbranch that previously dropped
nullentirely).