Files
pydantic/docs/examples/schema1.py
T
Nikita Grishko d43ab483ee fix schema creation docs (#212)
* fix schema creation docs

* review fixes
2018-06-30 23:06:39 +01:00

41 lines
822 B
Python

from enum import IntEnum
from pydantic import BaseModel, Schema
class FooBar(BaseModel):
count: int
size: float = None
class Gender(IntEnum):
male = 1
female = 2
other = 3
not_given = 4
class MainModel(BaseModel):
"""
This is the description of the main model
"""
foo_bar: FooBar = Schema(...)
gender: Gender = Schema(
None,
alias='Gender',
choice_names={3: 'Other Gender', 4: "I'd rather not say"}
)
snap: int = Schema(
42,
title='The Snap',
description='this is the value of snap'
)
class Config:
title = 'Main'
print(MainModel.schema())
# > {
# 'type': 'object',
# 'title': 'Main',
# 'properties': {
# 'foo_bar': {
# ...
print(MainModel.schema_json(indent=2))