Customize JSON schema generation for Literal fields of Pydantic models
#227
Conversation
This file contains 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
So that `Literal` types of a single value will also have a JSON schema that has a `"type"` key with the value of the type of the single value. This behavior is the one exhibited in Pydantic V1.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #227 +/- ##
==========================================
- Coverage 97.66% 91.57% -6.10%
==========================================
Files 18 18
Lines 1799 1816 +17
==========================================
- Hits 1757 1663 -94
- Misses 42 153 +111
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
candleindark
referenced
this pull request
in dandi/dandi-archive
Feb 12, 2024
Pydantic 2.0's JSON schema export no longer specifies a `type` field for the `schemaKey` property, and leaves it undefined instead. This change makes it so an undefined type also delegates it as a "basic schema", meaning it will not be rendered as its own tab in the meditor.
|
As stated in dandi/dandi-archive@b3db231#commitcomment-138536168, this PR is really not needed at all if the UI is able to construed the type of the value from the expression of the value in JSON. |
|
This PR is not needed per dandi/dandi-archive@b3db231#commitcomment-138536466. |
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.
This PR adds customization to the generation of JSON schema for the fields of Pydantic models that are of
Literaltype. Basically, this customization ensures that the JSON schema for aLiteralfield of a Pydantic model has atypekey.This customization revert change 3v entailed by Pydantic V2 listed in the top post of #203. Hopefully, it will also satisfy @satra's request at dandi/dandi-archive@b3db231#commitcomment-138484018.