Implement schema_extra #663
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #663 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 15 15
Lines 2725 2727 +2
Branches 539 539
=====================================
+ Hits 2725 2727 +2 |
docs/examples/schema4.py
Outdated
|
|
||
| class Config: | ||
| schema_extra = { | ||
| "examples": [ |
|
any chance we could get this fixed? I would like to get everything currently pending on the next release so I can work exclusively on v1. |
|
Thanks for your patience. Is it ok |
I personally think this is fine, it's remotely possible in future that we might allow |
tiangolo
commented
Aug 5, 2019
| v0.32 (unreleased) | ||
| .................. | ||
| * add model name to ``ValidationError`` error message, #676 by @dmontagu | ||
| * **breaking change**: remove ``__getattr__`` and rename ``__values__`` to ``__dict__`` on ``BaseModel``, | ||
| deprecation warning on use ``__values__`` attr, attributes access speed increased up to 14 times, #712 by @MrMrRobat | ||
| * support ``ForwardRef`` (without self-referencing annotations) in Python3.6, #706 by @koxudaxi | ||
| * implement ``schema_extra`` in ``Config`` sub-class, #663 by @tiangolo |
There was a problem hiding this comment.
Oh! Sorry, didn't notice I put it in the wrong place.
|
Great, agreed. |
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.
Change Summary
This adds an attribute
schema_extrato theConfigsub-class, allowing to extend/update the generated JSON Schema.For example, to include
examples, or to override the default JSON Schema generated for some field.This doesn't change validation/parsing, it's purely for extending/documenting models with JSON Schema.
Related issue number
#627, #529, #478, #619, #637, tiangolo/fastapi#363
Checklist
HISTORY.rsthas been updated#<number>@<whomever>