Upgrading fastapi 0.98 to 0.99
Review needed0.98.0 → 0.99.1New4Changed1Fixed1Other16
Review neededUpgrade verdict
1 changed default.
In plain terms
- Nothing in this range needs changes to your code. It adds features and fixes.
Must act Nothing to change
No breaking, platform, security or deprecated items in this range.
Adds typing-extensions >=4.5.0.
Nothing in this upgrade needs a code or configuration change.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- changed:
constructor FastAPI(*, debug: bool=…, routes: Optional[List[BaseRoute]]=…, title: str=…, description: str=…, version: str=…, openapi_url: Optional[str]=…, openapi_tags: Optional[List[Dict[str, Any]]]=…, servers: Optional[List[Dict[str, Union[str, Any]]]]=…, dependencies: Optional[Sequence[Depends]]=…, default_response_class: Type[Response]=…, redirect_slashes: bool=…, docs_url: Optional[str]=…, r… → constructor FastAPI(*, debug: bool=…, routes: Optional[List[BaseRoute]]=…, title: str=…, summary: Optional[str]=…, description: str=…, version: str=…, openapi_url: Optional[str]=…, openapi_tags: Optional[List[Dict[str, Any]]]=…, servers: Optional[List[Dict[str, Union[str, Any]]]]=…, dependencies: Optional[Sequence[Depends]]=…, default_response_class: Type[Response]=…, redirect_slashes: bool=…, do…
- removed:
field Schema.nullable: Optional[bool] - changed:
field OpenAPI.paths: Dict[str, Union[PathItem, Any]] → field OpenAPI.paths: Optional[Dict[str, Union[PathItem, Any]]] - changed:
field Operation.responses: Dict[str, Union[Response, Any]] → field Operation.responses: Optional[Dict[str, Union[Response, Any]]] - changed:
field Schema.additionalProperties: Optional[Union[Schema, Reference, bool]] → field Schema.additionalProperties: Optional[SchemaOrBool] - changed:
field Schema.allOf: Optional[List[Schema]] → field Schema.allOf: Optional[List[SchemaOrBool]] - changed:
field Schema.anyOf: Optional[List[Schema]] → field Schema.anyOf: Optional[List[SchemaOrBool]] - changed:
field Schema.example: Optional[Any] → field Schema.example: Annotated[Optional[Any], typing_deprecated('Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.')] - changed:
field Schema.items: Optional[Union[Schema, List[Schema]]] → field Schema.items: Optional[Union[SchemaOrBool, List[SchemaOrBool]]] - changed:
field Schema.not_: Optional[Schema] → field Schema.not_: Optional[SchemaOrBool] - changed:
field Schema.oneOf: Optional[List[Schema]] → field Schema.oneOf: Optional[List[SchemaOrBool]] - changed:
field Schema.properties: Optional[Dict[str, Schema]] → field Schema.properties: Optional[Dict[str, SchemaOrBool]] - changed:
field ServerVariable.enum: Optional[List[str]] → field ServerVariable.enum: Annotated[Optional[List[str]], Field(min_items=1)] - added:
field Components.pathItems: Optional[Dict[str, Union[PathItem, Reference]]] - added:
field Info.summary: Optional[str] - added:
field License.identifier: Optional[str] - added:
field OpenAPI.jsonSchemaDialect: Optional[str] - added:
field OpenAPI.webhooks: Optional[Dict[str, Union[PathItem, Reference]]] - added:
field Schema.anchor: Optional[str] - added:
field Schema.comment: Optional[str] - added:
field Schema.const: Optional[Any] - added:
field Schema.contains: Optional[SchemaOrBool] - added:
field Schema.contentEncoding: Optional[str] - added:
field Schema.contentMediaType: Optional[str] - added:
field Schema.contentSchema: Optional[SchemaOrBool] - added:
field Schema.defs: Optional[Dict[str, SchemaOrBool]] - added:
field Schema.dependentRequired: Optional[Dict[str, Set[str]]] - added:
field Schema.dependentSchemas: Optional[Dict[str, SchemaOrBool]] - added:
field Schema.dynamicAnchor: Optional[str] - added:
field Schema.dynamicRef: Optional[str] - added:
field Schema.else_: Optional[SchemaOrBool] - added:
field Schema.examples: Optional[List[Any]] - added:
field Schema.id: Optional[str] - added:
field Schema.if_: Optional[SchemaOrBool] - added:
field Schema.maxContains: Optional[int] - added:
field Schema.minContains: Optional[int] - added:
field Schema.patternProperties: Optional[Dict[str, SchemaOrBool]] - added:
field Schema.prefixItems: Optional[List[SchemaOrBool]] - added:
field Schema.propertyNames: Optional[SchemaOrBool] - added:
field Schema.schema_: Optional[str] - added:
field Schema.then: Optional[SchemaOrBool] - added:
field Schema.unevaluatedItems: Optional[SchemaOrBool] - added:
field Schema.unevaluatedProperties: Optional[SchemaOrBool] - added:
field Schema.vocabulary: Optional[str] - added:
variable SchemaOrBool
- changed:
function get_openapi(*, title: str, version: str, openapi_version: str=…, description: Optional[str]=…, routes: Sequence[BaseRoute], tags: Optional[List[Dict[str, Any]]]=…, servers: Optional[List[Dict[str, Union[str, Any]]]]=…, terms_of_service: Optional[str]=…, contact: Optional[Dict[str, Union[str, Any]]]=…, license_info: Optional[Dict[str, Union[str, Any]]]=…) -> Dict[str, Any] → function get_openapi(*, title: str, version: str, openapi_version: str=…, summary: Optional[str]=…, description: Optional[str]=…, routes: Sequence[BaseRoute], webhooks: Optional[Sequence[BaseRoute]]=…, tags: Optional[List[Dict[str, Any]]]=…, servers: Optional[List[Dict[str, Union[str, Any]]]]=…, terms_of_service: Optional[str]=…, contact: Optional[Dict[str, Union[str, Any]]]=…, license_info: Opti…
- changed:
function Body(default: Any=…, *, embed: bool=…, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) -> Any → function Body(default: Any=…, *, embed: bool=…, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('D… - changed:
function Cookie(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…, *… → function Cookie(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 that… - changed:
function File(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) -> Any → function File(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in Op… - changed:
function Form(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) -> Any → function Form(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in Op… - changed:
function Header(default: Any=…, *, alias: Optional[str]=…, convert_underscores: bool=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…,… → function Header(default: Any=…, *, alias: Optional[str]=…, convert_underscores: bool=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Depr… - changed:
function Path(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…, **e… → function Path(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 that no… - changed:
function Query(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…, **… → function Query(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 that n…
- changed:
constructor Body(default: Any=…, *, embed: bool=…, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) → constructor Body(default: Any=…, *, embed: bool=…, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated… - changed:
constructor Cookie(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…… → constructor Cookie(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 th… - changed:
constructor File(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) → constructor File(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in… - changed:
constructor Form(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, **extra: Any) → constructor Form(default: Any=…, *, media_type: str=…, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in… - changed:
constructor Header(default: Any=…, *, alias: Optional[str]=…, convert_underscores: bool=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]… → constructor Header(default: Any=…, *, alias: Optional[str]=…, convert_underscores: bool=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('D… - changed:
constructor Param(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…,… → constructor Param(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 tha… - changed:
constructor Path(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…,… → constructor Path(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 that… - changed:
constructor Query(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, example: Any=…, examples: Optional[Dict[str, Any]]=…, deprecated: Optional[bool]=…, include_in_schema: bool=…,… → constructor Query(default: Any=…, *, alias: Optional[str]=…, title: Optional[str]=…, description: Optional[str]=…, gt: Optional[float]=…, ge: Optional[float]=…, lt: Optional[float]=…, le: Optional[float]=…, min_length: Optional[int]=…, max_length: Optional[int]=…, regex: Optional[str]=…, examples: Optional[List[Any]]=…, example: Annotated[Optional[Any], deprecated('Deprecated in OpenAPI 3.1.0 tha…