Upgrading fastapi 0.37 to 0.38
Breaking0.37.0 → 0.38.1Breaking1New2Fixed1
BreakingUpgrade verdict
1 breaking change.
In plain terms
- Upgrade support to Pydantic version 0.32.2 and update internal code to use it (breaking change).
Must act 1 item needs code or config changes
What you must change
Breaking1
Upgrade support to Pydantic version 0.32.2 and update internal code to use it (breaking change).
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- changed:
method FastAPI.add_api_route(path: str, endpoint: Callable, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_ex… → method FastAPI.add_api_route(path: str, endpoint: Callable, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAn… - changed:
method FastAPI.api_route(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, respo… → method FastAPI.api_route(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exc… - changed:
method FastAPI.delete(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=… → method FastAPI.delete(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, Di… - changed:
method FastAPI.get(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…,… → method FastAPI.get(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, DictI… - changed:
method FastAPI.head(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…,… → method FastAPI.head(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, Dict… - changed:
method FastAPI.options(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool… → method FastAPI.options(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, D… - changed:
method FastAPI.patch(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…… → method FastAPI.patch(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, Dic… - changed:
method FastAPI.post(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…,… → method FastAPI.post(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, Dict… - changed:
method FastAPI.put(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…,… → method FastAPI.put(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, DictI… - changed:
method FastAPI.trace(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…… → method FastAPI.trace(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, Dic…
- changed:
function jsonable_encoder(obj: Any, include: Set[str]=…, exclude: Set[str]=…, by_alias: bool=…, skip_defaults: bool=…, include_none: bool=…, custom_encoder: dict=…, sqlalchemy_safe: bool=…) -> Any → function jsonable_encoder(obj: Any, include: Union[SetIntStr, DictIntStrAny]=…, exclude: Union[SetIntStr, DictIntStrAny]=…, by_alias: bool=…, skip_defaults: bool=…, include_none: bool=…, custom_encoder: dict=…, sqlalchemy_safe: bool=…) -> Any - added:
variable DictIntStrAny - added:
variable SetIntStr
- added:
constructor RequestValidationError(errors: Sequence[ErrorList]) -> None - added:
constructor WebSocketRequestValidationError(errors: Sequence[ErrorList]) -> None
- changed:
function get_app(dependant: Dependant, body_field: Field=…, status_code: int=…, response_class: Type[Response]=…, response_field: Field=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias: bool=…, response_model_skip_defaults: bool=…, dependency_overrides_provider: Any=…) -> Callable → function get_app(dependant: Dependant, body_field: Field=…, status_code: int=…, response_class: Type[Response]=…, response_field: Field=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntStr, DictIntStrAny]=…, response_model_by_alias: bool=…, response_model_skip_defaults: bool=…, dependency_overrides_provider: Any=…) -> Callable - changed:
function serialize_response(*, field: Field=…, response: Response, include: Set[str]=…, exclude: Set[str]=…, by_alias: bool=…, skip_defaults: bool=…) -> Any → function serialize_response(*, field: Field=…, response: Response, include: Union[SetIntStr, DictIntStrAny]=…, exclude: Union[SetIntStr, DictIntStrAny]=…, by_alias: bool=…, skip_defaults: bool=…) -> Any - changed:
method APIRouter.api_route(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]… → method APIRouter.api_route(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, methods: List[str]=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_… - changed:
method APIRouter.delete(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_ali… → method APIRouter.delete(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetI… - changed:
method APIRouter.get(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias:… → method APIRouter.get(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntS… - changed:
method APIRouter.head(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias… → method APIRouter.head(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetInt… - changed:
method APIRouter.options(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_al… → method APIRouter.options(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[Set… - changed:
method APIRouter.patch(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alia… → method APIRouter.patch(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIn… - changed:
method APIRouter.post(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias… → method APIRouter.post(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetInt… - changed:
method APIRouter.put(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alias:… → method APIRouter.put(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIntS… - changed:
method APIRouter.trace(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Set[str]=…, response_model_exclude: Set[str]=…, response_model_by_alia… → method APIRouter.trace(path: str, *, response_model: Type[Any]=…, status_code: int=…, tags: List[str]=…, dependencies: Sequence[params.Depends]=…, summary: str=…, description: str=…, response_description: str=…, responses: Dict[Union[int, str], Dict[str, Any]]=…, deprecated: bool=…, operation_id: str=…, response_model_include: Union[SetIntStr, DictIntStrAny]=…, response_model_exclude: Union[SetIn…