Repository navigation
Emit compact type arrays for JSON Schema unions #12599
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Timothee Guerin (timotheeguerin)
wants to merge
6
commits into
microsoft:main
Choose a base branch
from
timotheeguerin:timotheeguerin-compact-json-schema-unions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
faec03b
feat(json-schema): emit compact type arrays for unions
timotheeguerin e5a7283
fix(json-schema): preserve union variants with extensions
timotheeguerin 7cb7a48
docs(json-schema): remove issue reference from changelog
timotheeguerin 46c6620
Merge branch 'main' into timotheeguerin-compact-json-schema-unions
timotheeguerin b44597e
docs(json-schema): clarify extension escape hatch design
timotheeguerin acc8e4b
docs(json-schema): move design decisions into the package
timotheeguerin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| changeKind: feature | ||
| packages: | ||
| - "@typespec/json-schema" | ||
| --- | ||
|
|
||
| Emit unconstrained union variants as a compact JSON Schema `type` array instead of separate `anyOf` branches, preserving constrained variants and explicit `@oneOf` behavior. | ||
|
|
||
| For example, `value: string | null` now emits: | ||
|
|
||
| ```json | ||
| { "type": ["string", "null"] } | ||
| ``` |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # JSON Schema design decisions | ||
|
|
||
| ## Extensions are an escape hatch | ||
|
|
||
| `@extension` adds arbitrary schema keywords. Guarding against misuse of this escape hatch is a non-goal. Users are responsible for the validity and semantics of extensions that override or conflict with emitter-generated keywords such as `type`, `anyOf`, or `$ref`. | ||
|
|
||
| Emitter changes may alter the generated schema structure while preserving the semantics of the TypeSpec types. They do not need to preserve the validation behavior of extensions that depend on replacing a particular generated keyword. For example, replacing `anyOf` through an extension does not require the emitter to retain an `anyOf` layer instead of compacting a union into a `type` array. | ||
|
|
||
| Defensive logic and regression tests solely to preserve behavior under such overrides are outside the emitter's scope. Ordinary custom keywords and vendor extensions must still be emitted correctly. |
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.