Addressing Heitor's feedback

Author: leandrodamascena

aws_lambda_powertools/event_handler/openapi/compat.py

@@ -22,6 +22,10 @@
 )
 
 from pydantic import TypeAdapter, ValidationError
+
+# Importing from internal libraries in Pydantic may introduce potential risks, as these internal libraries
+# are not part of the public API and may change without notice in future releases.
+# We use this for forward reference, as it allows us to handle forward references in type annotations.
 from pydantic._internal._typing_extra import eval_type_lenient
 from pydantic.fields import FieldInfo
 from pydantic._internal._utils import lenient_issubclass

aws_lambda_powertools/event_handler/openapi/constants.py

@@ -1,2 +1,6 @@
+from pydantic import ConfigDict
+
 DEFAULT_API_VERSION = "1.0.0"
 DEFAULT_OPENAPI_VERSION = "3.1.0"
+MODEL_CONFIG_ALLOW = ConfigDict(extra="allow")
+MODEL_CONFIG_IGNORE = ConfigDict(extra="ignore")

aws_lambda_powertools/event_handler/openapi/encoders.py

@@ -11,7 +11,6 @@
 
 from pydantic import BaseModel
 from pydantic.types import SecretBytes, SecretStr
-from pydantic_extra_types.color import Color
 
 from aws_lambda_powertools.event_handler.openapi.compat import _model_dump
 from aws_lambda_powertools.event_handler.openapi.types import IncEx
@@ -318,7 +317,6 @@ def decimal_encoder(dec_value: Decimal) -> Union[int, float]:
 # Encoders for types that are not JSON serializable
 ENCODERS_BY_TYPE: Dict[Type[Any], Callable[[Any], Any]] = {
     bytes: lambda o: o.decode(),
-    Color: str,
     datetime.date: iso_format,
     datetime.datetime: iso_format,
     datetime.time: iso_format,

aws_lambda_powertools/event_handler/openapi/models.py

@@ -4,6 +4,10 @@
 from pydantic import AnyUrl, BaseModel, Field
 
 from aws_lambda_powertools.event_handler.openapi.compat import model_rebuild
+from aws_lambda_powertools.event_handler.openapi.constants import (
+    MODEL_CONFIG_ALLOW,
+    MODEL_CONFIG_IGNORE,
+)
 from aws_lambda_powertools.shared.types import Annotated, Literal
 
 """
@@ -18,7 +22,7 @@ class Contact(BaseModel):
     url: Optional[AnyUrl] = None
     email: Optional[str] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#license-object
@@ -27,7 +31,7 @@ class License(BaseModel):
     identifier: Optional[str] = None
     url: Optional[AnyUrl] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#info-object
@@ -40,7 +44,7 @@ class Info(BaseModel):
     version: str
     summary: Optional[str] = None
 
-    model_config = {"extra": "ignore"}
+    model_config = MODEL_CONFIG_IGNORE
 
 
 # https://swagger.io/specification/#server-variable-object
@@ -49,7 +53,7 @@ class ServerVariable(BaseModel):
     default: str
     description: Optional[str] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#server-object
@@ -58,7 +62,7 @@ class Server(BaseModel):
     description: Optional[str] = None
     variables: Optional[Dict[str, ServerVariable]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#reference-object
@@ -80,15 +84,15 @@ class XML(BaseModel):
     attribute: Optional[bool] = None
     wrapped: Optional[bool] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#external-documentation-object
 class ExternalDocumentation(BaseModel):
     description: Optional[str] = None
     url: AnyUrl
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#schema-object
@@ -171,7 +175,7 @@ class Schema(BaseModel):
     xml: Optional[XML] = None
     externalDocs: Optional[ExternalDocumentation] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # Ref: https://json-schema.org/draft/2020-12/json-schema-core.html#name-json-schema-documents
@@ -186,7 +190,7 @@ class Example(BaseModel):
     value: Optional[Any] = None
     externalValue: Optional[AnyUrl] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 class ParameterInType(Enum):
@@ -204,7 +208,7 @@ class Encoding(BaseModel):
     explode: Optional[bool] = None
     allowReserved: Optional[bool] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#media-type-object
@@ -213,7 +217,7 @@ class MediaType(BaseModel):
     examples: Optional[Dict[str, Union[Example, Reference]]] = None
     encoding: Optional[Dict[str, Encoding]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#parameter-object
@@ -230,7 +234,7 @@ class ParameterBase(BaseModel):
     # Serialization rules for more complex scenarios
     content: Optional[Dict[str, MediaType]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 class Parameter(ParameterBase):
@@ -248,7 +252,7 @@ class RequestBody(BaseModel):
     content: Dict[str, MediaType]
     required: Optional[bool] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#link-object
@@ -260,7 +264,7 @@ class Link(BaseModel):
     description: Optional[str] = None
     server: Optional[Server] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#response-object
@@ -270,7 +274,7 @@ class Response(BaseModel):
     content: Optional[Dict[str, MediaType]] = None
     links: Optional[Dict[str, Union[Link, Reference]]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#tag-object
@@ -279,7 +283,7 @@ class Tag(BaseModel):
     description: Optional[str] = None
     externalDocs: Optional[ExternalDocumentation] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#operation-object
@@ -298,7 +302,7 @@ class Operation(BaseModel):
     security: Optional[List[Dict[str, List[str]]]] = None
     servers: Optional[List[Server]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#path-item-object
@@ -317,7 +321,7 @@ class PathItem(BaseModel):
     servers: Optional[List[Server]] = None
     parameters: Optional[List[Union[Parameter, Reference]]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#security-scheme-object
@@ -361,7 +365,7 @@ class OAuthFlow(BaseModel):
     refreshUrl: Optional[str] = None
     scopes: Dict[str, str] = {}
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 class OAuthFlowImplicit(OAuthFlow):
@@ -387,7 +391,7 @@ class OAuthFlows(BaseModel):
     clientCredentials: Optional[OAuthFlowClientCredentials] = None
     authorizationCode: Optional[OAuthFlowAuthorizationCode] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 class OAuth2(SecurityBase):
@@ -420,7 +424,7 @@ class Components(BaseModel):
     callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference, Any]]] = None
     pathItems: Optional[Dict[str, Union[PathItem, Reference]]] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 # https://swagger.io/specification/#openapi-object
@@ -437,7 +441,7 @@ class OpenAPI(BaseModel):
     tags: Optional[List[Tag]] = None
     externalDocs: Optional[ExternalDocumentation] = None
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
 
 model_rebuild(Schema)

aws_lambda_powertools/event_handler/openapi/swagger_ui/oauth2.py

@@ -4,6 +4,9 @@
 
 from pydantic import BaseModel, Field, field_validator
 
+from aws_lambda_powertools.event_handler.openapi.constants import (
+    MODEL_CONFIG_ALLOW,
+)
 from aws_lambda_powertools.shared.functions import powertools_dev_is_set
 
 
@@ -41,7 +44,7 @@ class OAuth2Config(BaseModel):
     # Whether to use PKCE with the authorization code grant type. Defaults to False.
     usePkceWithAuthorizationCodeGrant: bool = Field(alias="use_pkce_with_authorization_code_grant", default=False)
 
-    model_config = {"extra": "allow"}
+    model_config = MODEL_CONFIG_ALLOW
 
     @field_validator("clientSecret")
     def client_secret_only_on_dev(cls, v: Optional[str]) -> Optional[str]: