Clean up pydantic JSON Schema and generated TypeScript types#161
Merged
Conversation
gjreda
approved these changes
Jun 15, 2023
Collaborator
|
part of the work for #136 |
Closed
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.
We were getting some odd type aliases on the TypeScript side because Pydantic generated JSON Schema with fields like this:
{ "given_name": { "title": "Given Name", "type": "string" } }json-schema-to-typescript turns this into:
and then uses that as a type alias. The party line from both projects is that they're both doing this correctly (see bcherny/json-schema-to-typescript#504 and pydantic/pydantic#1740), however pydantic seems to recognize that this may not be what everyone wants and provides example code to strip off
titlein their docs:"For example, the title key can be removed from the model's properties:"
https://docs.pydantic.dev/latest/usage/schema/#schema-customization
We can define our own base model to use this in all our API types.