fastapi 0.102.0__py3-none-any.whl → 0.103.0__py3-none-any.whl

fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.102.0"
+__version__ = "0.103.0"
 
 from starlette import status as status
 

fastapi/openapi/models.py

@@ -11,7 +11,7 @@ from fastapi._compat import (
 )
 from fastapi.logger import logger
 from pydantic import AnyUrl, BaseModel, Field
-from typing_extensions import Annotated, Literal
+from typing_extensions import Annotated, Literal, TypedDict
 from typing_extensions import deprecated as typing_deprecated
 
 try:
@@ -267,14 +267,14 @@ class Schema(BaseModel):
 SchemaOrBool = Union[Schema, bool]
 
 
-class Example(BaseModel):
-    summary: Optional[str] = None
-    description: Optional[str] = None
-    value: Optional[Any] = None
-    externalValue: Optional[AnyUrl] = None
+class Example(TypedDict, total=False):
+    summary: Optional[str]
+    description: Optional[str]
+    value: Optional[Any]
+    externalValue: Optional[AnyUrl]
 
-    if PYDANTIC_V2:
-        model_config = {"extra": "allow"}
+    if PYDANTIC_V2:  # type: ignore [misc]
+        __pydantic_config__ = {"extra": "allow"}
 
     else:
 

fastapi/openapi/utils.py

@@ -118,7 +118,9 @@ def get_openapi_operation_parameters(
         }
         if field_info.description:
             parameter["description"] = field_info.description
-        if field_info.example != Undefined:
+        if field_info.openapi_examples:
+            parameter["examples"] = jsonable_encoder(field_info.openapi_examples)
+        elif field_info.example != Undefined:
             parameter["example"] = jsonable_encoder(field_info.example)
         if field_info.deprecated:
             parameter["deprecated"] = field_info.deprecated
@@ -153,7 +155,11 @@ def get_openapi_operation_request_body(
     if required:
         request_body_oai["required"] = required
     request_media_content: Dict[str, Any] = {"schema": body_schema}
-    if field_info.example != Undefined:
+    if field_info.openapi_examples:
+        request_media_content["examples"] = jsonable_encoder(
+            field_info.openapi_examples
+        )
+    elif field_info.example != Undefined:
         request_media_content["example"] = jsonable_encoder(field_info.example)
     request_body_oai["content"] = {request_media_type: request_media_content}
     return request_body_oai

fastapi/param_functions.py

@@ -2,6 +2,7 @@ from typing import Any, Callable, Dict, List, Optional, Sequence, Union
 
 from fastapi import params
 from fastapi._compat import Undefined
+from fastapi.openapi.models import Example
 from typing_extensions import Annotated, deprecated
 
 _Unset: Any = Undefined
@@ -46,6 +47,7 @@ def Path(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -76,6 +78,7 @@ def Path(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -122,6 +125,7 @@ def Query(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -152,6 +156,7 @@ def Query(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -199,6 +204,7 @@ def Header(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -230,6 +236,7 @@ def Header(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -276,6 +283,7 @@ def Cookie(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -306,6 +314,7 @@ def Cookie(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -354,6 +363,7 @@ def Body(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -386,6 +396,7 @@ def Body(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -433,6 +444,7 @@ def Form(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -464,6 +476,7 @@ def Form(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,
@@ -511,6 +524,7 @@ def File(  # noqa: N802
             "although still supported. Use examples instead."
         ),
     ] = _Unset,
+    openapi_examples: Optional[Dict[str, Example]] = None,
     deprecated: Optional[bool] = None,
     include_in_schema: bool = True,
     json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -542,6 +556,7 @@ def File(  # noqa: N802
         decimal_places=decimal_places,
         example=example,
         examples=examples,
+        openapi_examples=openapi_examples,
         deprecated=deprecated,
         include_in_schema=include_in_schema,
         json_schema_extra=json_schema_extra,

fastapi/params.py

@@ -2,6 +2,7 @@ import warnings
 from enum import Enum
 from typing import Any, Callable, Dict, List, Optional, Sequence, Union
 
+from fastapi.openapi.models import Example
 from pydantic.fields import FieldInfo
 from typing_extensions import Annotated, deprecated
 
@@ -61,6 +62,7 @@ class Param(FieldInfo):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -75,6 +77,7 @@ class Param(FieldInfo):
             )
         self.example = example
         self.include_in_schema = include_in_schema
+        self.openapi_examples = openapi_examples
         kwargs = dict(
             default=default,
             default_factory=default_factory,
@@ -170,6 +173,7 @@ class Path(Param):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -204,6 +208,7 @@ class Path(Param):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,
@@ -254,6 +259,7 @@ class Query(Param):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -286,6 +292,7 @@ class Query(Param):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,
@@ -337,6 +344,7 @@ class Header(Param):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -370,6 +378,7 @@ class Header(Param):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,
@@ -420,6 +429,7 @@ class Cookie(Param):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -452,6 +462,7 @@ class Cookie(Param):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,
@@ -502,6 +513,7 @@ class Body(FieldInfo):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -518,6 +530,7 @@ class Body(FieldInfo):
             )
         self.example = example
         self.include_in_schema = include_in_schema
+        self.openapi_examples = openapi_examples
         kwargs = dict(
             default=default,
             default_factory=default_factory,
@@ -613,6 +626,7 @@ class Form(Body):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -647,6 +661,7 @@ class Form(Body):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,
@@ -696,6 +711,7 @@ class File(Form):
                 "although still supported. Use examples instead."
             ),
         ] = _Unset,
+        openapi_examples: Optional[Dict[str, Example]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
         json_schema_extra: Union[Dict[str, Any], None] = None,
@@ -729,6 +745,7 @@ class File(Form):
             deprecated=deprecated,
             example=example,
             examples=examples,
+            openapi_examples=openapi_examples,
             include_in_schema=include_in_schema,
             json_schema_extra=json_schema_extra,
             **extra,

{fastapi-0.102.0.dist-info → fastapi-0.103.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi
-Version: 0.102.0
+Version: 0.103.0
 Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
 Project-URL: Homepage, https://github.com/tiangolo/fastapi
 Project-URL: Documentation, https://fastapi.tiangolo.com/

{fastapi-0.102.0.dist-info → fastapi-0.103.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-fastapi/__init__.py,sha256=9rDgMb5-jWs7d6iWSLEk71ixy123N0THKS_H8CxiIdk,1081
+fastapi/__init__.py,sha256=h0fWTZ2oDwWSIdR2lMOSBUBP2yKgc0EastyxddBu5Aw,1081
 fastapi/_compat.py,sha256=rIhdPUb9XYHxkeCJH1EdVDB3d93Ne2cGhlHb65p9edY,22568
 fastapi/applications.py,sha256=hCZttoVGHOZ2jRMwJ_ntXFzjuAXVreFGv5mPhy6MFaA,40230
 fastapi/background.py,sha256=HtN5_pJJrOdalSbuGSMKJAPNWUU5h7rY_BXXubu7-IQ,76
@@ -8,8 +8,8 @@ fastapi/encoders.py,sha256=4EZEx0D8NjMLr793L9gBSc867V_WwsA22LWxroPy13Y,8044
 fastapi/exception_handlers.py,sha256=MBrIOA-ugjJDivIi4rSsUJBdTsjuzN76q4yh0q1COKw,1332
 fastapi/exceptions.py,sha256=svNjh4_VJogfG3dzsn21TtwOxy6l-bXIoYxoUjAxteI,1585
 fastapi/logger.py,sha256=I9NNi3ov8AcqbsbC9wl1X-hdItKgYt2XTrx1f99Zpl4,54
-fastapi/param_functions.py,sha256=ycrVFfSANRCgaAaRT7pC9_5okx_e4D0L8NUz6wTUKAw,18411
-fastapi/params.py,sha256=3WiA6CdfbtvVM6-TYdsFfIICNZx64ZeuQ77_R5LiVq4,26880
+fastapi/param_functions.py,sha256=_bqVX6LLUFjFOuua7UBIP3dXRpcdyrsnFEwPqBokwV8,19168
+fastapi/params.py,sha256=LzjihAvODd3w7-GddraUyVtH1xfwR9smIoQn-Z_g4mg,27807
 fastapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fastapi/requests.py,sha256=zayepKFcienBllv3snmWI20Gk0oHNVLU4DDhqXBb4LU,142
 fastapi/responses.py,sha256=on95e4CfSRyNz7MEjqFuzsP-eW8kHWTxEl_Z-Vzb7lA,1242
@@ -33,8 +33,8 @@ fastapi/middleware/wsgi.py,sha256=Z3Ue-7wni4lUZMvH3G9ek__acgYdJstbnpZX_HQAboY,79
 fastapi/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fastapi/openapi/constants.py,sha256=adGzmis1L1HJRTE3kJ5fmHS_Noq6tIY6pWv_SFzoFDU,153
 fastapi/openapi/docs.py,sha256=HbP76-u4A45BrL4WjLMhA3MBVI9xMx7XiMyDRS_ZO0E,6532
-fastapi/openapi/models.py,sha256=G_yoz3jFjCDZVE5xW0vcQPXRljtqhnbGR8oogEnr-Hc,17733
-fastapi/openapi/utils.py,sha256=wPRHgz5ZIAZOzx2hU6NA7C9lh919NYZL04gE2CVpTNM,22029
+fastapi/openapi/models.py,sha256=alc7SWZeDXSWWC-HMdsVGy53BuS2RBbGpK_IiSgaREA,17759
+fastapi/openapi/utils.py,sha256=PUuz_ISarHVPBRyIgfyHz8uwH0eEsDY3rJUfW__I9GI,22303
 fastapi/security/__init__.py,sha256=bO8pNmxqVRXUjfl2mOKiVZLn0FpBQ61VUYVjmppnbJw,881
 fastapi/security/api_key.py,sha256=92kxZjj9OuIvQCUpLszP9qlILRgx6hCh1x-bZdhmQDU,2939
 fastapi/security/base.py,sha256=dl4pvbC-RxjfbWgPtCWd8MVU-7CB2SZ22rJDXVCXO6c,141
@@ -42,7 +42,7 @@ fastapi/security/http.py,sha256=VbTm1k6t6EjJAnCnYVquSOmSK7fATdKRgq0-TgC7FnQ,5964
 fastapi/security/oauth2.py,sha256=fXQdWuTtUKSZ9Lyrj9fDuQoXAmXTd9AVFDrrwStJKX0,8579
 fastapi/security/open_id_connect_url.py,sha256=GKK84g6OZbOFCEZJyd27pGjpaClGxeZrYOemUzyhfbU,1141
 fastapi/security/utils.py,sha256=bd8T0YM7UQD5ATKucr1bNtAvz_Y3__dVNAv5UebiPvc,293
-fastapi-0.102.0.dist-info/METADATA,sha256=zOGiKhJjW5Q2oJHn9z_t4I3xMbf34hqbyjVTXraUPbo,24070
-fastapi-0.102.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-fastapi-0.102.0.dist-info/licenses/LICENSE,sha256=Tsif_IFIW5f-xYSy1KlhAy7v_oNEU4lP2cEnSQbMdE4,1086
-fastapi-0.102.0.dist-info/RECORD,,
+fastapi-0.103.0.dist-info/METADATA,sha256=5IzAieglNHsMCxopNzH1c8vkT2v_UnRyLDJ2zYu9ZLg,24070
+fastapi-0.103.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+fastapi-0.103.0.dist-info/licenses/LICENSE,sha256=Tsif_IFIW5f-xYSy1KlhAy7v_oNEU4lP2cEnSQbMdE4,1086
+fastapi-0.103.0.dist-info/RECORD,,