aws-lambda-powertools 2.34.2__py3-none-any.whl → 2.35.0__py3-none-any.whl

aws_lambda_powertools/event_handler/api_gateway.py

@@ -1455,10 +1455,25 @@ class ApiGatewayResolver(BaseRouter):
             get_definitions,
         )
         from aws_lambda_powertools.event_handler.openapi.models import OpenAPI, PathItem, Server, Tag
+        from aws_lambda_powertools.event_handler.openapi.pydantic_loader import PYDANTIC_V2
         from aws_lambda_powertools.event_handler.openapi.types import (
             COMPONENT_REF_TEMPLATE,
         )
 
+        # Pydantic V2 has no support for OpenAPI schema 3.0
+        if PYDANTIC_V2 and not openapi_version.startswith("3.1"):
+            warnings.warn(
+                "You are using Pydantic v2, which is incompatible with OpenAPI schema 3.0. Forcing OpenAPI 3.1",
+                stacklevel=2,
+            )
+            openapi_version = "3.1.0"
+        elif not PYDANTIC_V2 and not openapi_version.startswith("3.0"):
+            warnings.warn(
+                "You are using Pydantic v1, which is incompatible with OpenAPI schema 3.1. Forcing OpenAPI 3.0",
+                stacklevel=2,
+            )
+            openapi_version = "3.0.3"
+
         # Start with the bare minimum required for a valid OpenAPI schema
         info: Dict[str, Any] = {"title": title, "version": version}
 

aws_lambda_powertools/event_handler/bedrock_agent.py

@@ -1,13 +1,15 @@
 from re import Match
-from typing import Any, Dict
+from typing import Any, Callable, Dict, List, Optional
 
 from typing_extensions import override
 
 from aws_lambda_powertools.event_handler import ApiGatewayResolver
 from aws_lambda_powertools.event_handler.api_gateway import (
+    _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
     ProxyEventType,
     ResponseBuilder,
 )
+from aws_lambda_powertools.event_handler.openapi.types import OpenAPIResponse
 from aws_lambda_powertools.utilities.data_classes import BedrockAgentEvent
 
 
@@ -83,6 +85,166 @@ class BedrockAgentResolver(ApiGatewayResolver):
         )
         self._response_builder_class = BedrockResponseBuilder
 
+    # Note: we need ignore[override] because we are making the optional `description` field required.
+    @override
+    def get(  # type: ignore[override]
+        self,
+        rule: str,
+        description: str,
+        cors: Optional[bool] = None,
+        compress: bool = False,
+        cache_control: Optional[str] = None,
+        summary: Optional[str] = None,
+        responses: Optional[Dict[int, OpenAPIResponse]] = None,
+        response_description: str = _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
+        tags: Optional[List[str]] = None,
+        operation_id: Optional[str] = None,
+        include_in_schema: bool = True,
+        middlewares: Optional[List[Callable[..., Any]]] = None,
+    ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
+        return super(BedrockAgentResolver, self).get(
+            rule,
+            cors,
+            compress,
+            cache_control,
+            summary,
+            description,
+            responses,
+            response_description,
+            tags,
+            operation_id,
+            include_in_schema,
+            middlewares,
+        )
+
+    # Note: we need ignore[override] because we are making the optional `description` field required.
+    @override
+    def post(  # type: ignore[override]
+        self,
+        rule: str,
+        description: str,
+        cors: Optional[bool] = None,
+        compress: bool = False,
+        cache_control: Optional[str] = None,
+        summary: Optional[str] = None,
+        responses: Optional[Dict[int, OpenAPIResponse]] = None,
+        response_description: str = _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
+        tags: Optional[List[str]] = None,
+        operation_id: Optional[str] = None,
+        include_in_schema: bool = True,
+        middlewares: Optional[List[Callable[..., Any]]] = None,
+    ):
+        return super().post(
+            rule,
+            cors,
+            compress,
+            cache_control,
+            summary,
+            description,
+            responses,
+            response_description,
+            tags,
+            operation_id,
+            include_in_schema,
+            middlewares,
+        )
+
+    # Note: we need ignore[override] because we are making the optional `description` field required.
+    @override
+    def put(  # type: ignore[override]
+        self,
+        rule: str,
+        description: str,
+        cors: Optional[bool] = None,
+        compress: bool = False,
+        cache_control: Optional[str] = None,
+        summary: Optional[str] = None,
+        responses: Optional[Dict[int, OpenAPIResponse]] = None,
+        response_description: str = _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
+        tags: Optional[List[str]] = None,
+        operation_id: Optional[str] = None,
+        include_in_schema: bool = True,
+        middlewares: Optional[List[Callable[..., Any]]] = None,
+    ):
+        return super().put(
+            rule,
+            cors,
+            compress,
+            cache_control,
+            summary,
+            description,
+            responses,
+            response_description,
+            tags,
+            operation_id,
+            include_in_schema,
+            middlewares,
+        )
+
+    # Note: we need ignore[override] because we are making the optional `description` field required.
+    @override
+    def patch(  # type: ignore[override]
+        self,
+        rule: str,
+        description: str,
+        cors: Optional[bool] = None,
+        compress: bool = False,
+        cache_control: Optional[str] = None,
+        summary: Optional[str] = None,
+        responses: Optional[Dict[int, OpenAPIResponse]] = None,
+        response_description: str = _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
+        tags: Optional[List[str]] = None,
+        operation_id: Optional[str] = None,
+        include_in_schema: bool = True,
+        middlewares: Optional[List[Callable]] = None,
+    ):
+        return super().patch(
+            rule,
+            cors,
+            compress,
+            cache_control,
+            summary,
+            description,
+            responses,
+            response_description,
+            tags,
+            operation_id,
+            include_in_schema,
+            middlewares,
+        )
+
+    # Note: we need ignore[override] because we are making the optional `description` field required.
+    @override
+    def delete(  # type: ignore[override]
+        self,
+        rule: str,
+        description: str,
+        cors: Optional[bool] = None,
+        compress: bool = False,
+        cache_control: Optional[str] = None,
+        summary: Optional[str] = None,
+        responses: Optional[Dict[int, OpenAPIResponse]] = None,
+        response_description: str = _DEFAULT_OPENAPI_RESPONSE_DESCRIPTION,
+        tags: Optional[List[str]] = None,
+        operation_id: Optional[str] = None,
+        include_in_schema: bool = True,
+        middlewares: Optional[List[Callable[..., Any]]] = None,
+    ):
+        return super().delete(
+            rule,
+            cors,
+            compress,
+            cache_control,
+            summary,
+            description,
+            responses,
+            response_description,
+            tags,
+            operation_id,
+            include_in_schema,
+            middlewares,
+        )
+
     @override
     def _convert_matches_into_route_keys(self, match: Match) -> Dict[str, str]:
         # In Bedrock Agents, all the parameters come inside the "parameters" key, not on the apiPath

aws_lambda_powertools/event_handler/openapi/constants.py

@@ -1,2 +1,2 @@
 DEFAULT_API_VERSION = "1.0.0"
-DEFAULT_OPENAPI_VERSION = "3.0.0"
+DEFAULT_OPENAPI_VERSION = "3.0.3"

aws_lambda_powertools/event_handler/openapi/models.py

@@ -45,7 +45,6 @@ class License(BaseModel):
 # https://swagger.io/specification/#info-object
 class Info(BaseModel):
     title: str
-    summary: Optional[str] = None
     description: Optional[str] = None
     termsOfService: Optional[str] = None
     contact: Optional[Contact] = None
@@ -53,12 +52,13 @@ class Info(BaseModel):
     version: str
 
     if PYDANTIC_V2:
-        model_config = {"extra": "allow"}
+        summary: Optional[str] = None
+        model_config = {"extra": "ignore"}
 
     else:
 
         class Config:
-            extra = "allow"
+            extra = "ignore"
 
 
 # https://swagger.io/specification/#server-variable-object