aws-lambda-powertools 2.30.1__tar.gz → 2.31.0__tar.gz

{aws_lambda_powertools-2.30.1 → aws_lambda_powertools-2.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-lambda-powertools
-Version: 2.30.1
+Version: 2.31.0
 Summary: Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.
 Home-page: https://github.com/aws-powertools/powertools-lambda-python
 License: MIT

{aws_lambda_powertools-2.30.1 → aws_lambda_powertools-2.31.0}/aws_lambda_powertools/event_handler/api_gateway.py

@@ -80,6 +80,7 @@ if TYPE_CHECKING:
         License,
         OpenAPI,
         Server,
+        Tag,
     )
     from aws_lambda_powertools.event_handler.openapi.params import Dependant
     from aws_lambda_powertools.event_handler.openapi.types import (
@@ -559,7 +560,7 @@ class Route:
 
         # Ensure tags is added to the operation
         if self.tags:
-            operation["tags"] = [{"name": tag for tag in self.tags}]
+            operation["tags"] = self.tags
 
         # Ensure summary is added to the operation
         operation["summary"] = self._openapi_operation_summary()
@@ -616,6 +617,9 @@ class Route:
         if required:
             request_body_oai["required"] = required
 
+        if field_info.description:
+            request_body_oai["description"] = field_info.description
+
         # Generate the request body media type
         request_media_content: Dict[str, Any] = {"schema": body_schema}
         request_body_oai["content"] = {request_media_type: request_media_content}
@@ -1360,7 +1364,7 @@ class ApiGatewayResolver(BaseRouter):
         openapi_version: str = DEFAULT_OPENAPI_VERSION,
         summary: Optional[str] = None,
         description: Optional[str] = None,
-        tags: Optional[List[str]] = None,
+        tags: Optional[List[Union["Tag", str]]] = None,
         servers: Optional[List["Server"]] = None,
         terms_of_service: Optional[str] = None,
         contact: Optional["Contact"] = None,
@@ -1375,13 +1379,13 @@ class ApiGatewayResolver(BaseRouter):
             The title of the application.
         version: str
             The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API
-        openapi_version: str, default = "3.1.0"
+        openapi_version: str, default = "3.0.0"
             The version of the OpenAPI Specification (which the document uses).
         summary: str, optional
             A short summary of what the application does.
         description: str, optional
             A verbose explanation of the application behavior.
-        tags: List[str], optional
+        tags: List[Tag | str], optional
             A list of tags used by the specification with additional metadata.
         servers: List[Server], optional
             An array of Server Objects, which provide connectivity information to a target server.
@@ -1403,7 +1407,7 @@ class ApiGatewayResolver(BaseRouter):
             get_compat_model_name_map,
             get_definitions,
         )
-        from aws_lambda_powertools.event_handler.openapi.models import OpenAPI, PathItem, Server
+        from aws_lambda_powertools.event_handler.openapi.models import OpenAPI, PathItem, Server, Tag
         from aws_lambda_powertools.event_handler.openapi.types import (
             COMPONENT_REF_TEMPLATE,
         )
@@ -1468,7 +1472,7 @@ class ApiGatewayResolver(BaseRouter):
         if components:
             output["components"] = components
         if tags:
-            output["tags"] = [{"name": tag} for tag in tags]
+            output["tags"] = [Tag(name=tag) if isinstance(tag, str) else tag for tag in tags]
 
         output["paths"] = {k: PathItem(**v) for k, v in paths.items()}
 
@@ -1482,7 +1486,7 @@ class ApiGatewayResolver(BaseRouter):
         openapi_version: str = DEFAULT_OPENAPI_VERSION,
         summary: Optional[str] = None,
         description: Optional[str] = None,
-        tags: Optional[List[str]] = None,
+        tags: Optional[List[Union["Tag", str]]] = None,
         servers: Optional[List["Server"]] = None,
         terms_of_service: Optional[str] = None,
         contact: Optional["Contact"] = None,
@@ -1497,13 +1501,13 @@ class ApiGatewayResolver(BaseRouter):
             The title of the application.
         version: str
             The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API
-        openapi_version: str, default = "3.1.0"
+        openapi_version: str, default = "3.0.0"
             The version of the OpenAPI Specification (which the document uses).
         summary: str, optional
             A short summary of what the application does.
         description: str, optional
             A verbose explanation of the application behavior.
-        tags: List[str], optional
+        tags: List[Tag, str], optional
             A list of tags used by the specification with additional metadata.
         servers: List[Server], optional
             An array of Server Objects, which provide connectivity information to a target server.
@@ -1548,7 +1552,7 @@ class ApiGatewayResolver(BaseRouter):
         openapi_version: str = DEFAULT_OPENAPI_VERSION,
         summary: Optional[str] = None,
         description: Optional[str] = None,
-        tags: Optional[List[str]] = None,
+        tags: Optional[List[Union["Tag", str]]] = None,
         servers: Optional[List["Server"]] = None,
         terms_of_service: Optional[str] = None,
         contact: Optional["Contact"] = None,
@@ -1567,13 +1571,13 @@ class ApiGatewayResolver(BaseRouter):
             The title of the application.
         version: str
             The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API
-        openapi_version: str, default = "3.1.0"
+        openapi_version: str, default = "3.0.0"
             The version of the OpenAPI Specification (which the document uses).
         summary: str, optional
             A short summary of what the application does.
         description: str, optional
             A verbose explanation of the application behavior.
-        tags: List[str], optional
+        tags: List[Tag, str], optional
             A list of tags used by the specification with additional metadata.
         servers: List[Server], optional
             An array of Server Objects, which provide connectivity information to a target server.

{aws_lambda_powertools-2.30.1 → aws_lambda_powertools-2.31.0}/aws_lambda_powertools/event_handler/openapi/models.py

@@ -207,7 +207,7 @@ class Schema(BaseModel):
     readOnly: Optional[bool] = None
     writeOnly: Optional[bool] = None
     examples: Optional[List["Example"]] = None
-    # Ref: OpenAPI 3.1.0: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object
+    # Ref: OpenAPI 3.0.0: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#schema-object
     # Schema Object
     discriminator: Optional[Discriminator] = None
     xml: Optional[XML] = None
@@ -380,7 +380,7 @@ class Tag(BaseModel):
 
 # https://swagger.io/specification/#operation-object
 class Operation(BaseModel):
-    tags: Optional[List[Tag]] = None
+    tags: Optional[List[str]] = None
     summary: Optional[str] = None
     description: Optional[str] = None
     externalDocs: Optional[ExternalDocumentation] = None

{aws_lambda_powertools-2.30.1 → aws_lambda_powertools-2.31.0}/aws_lambda_powertools/event_handler/openapi/swagger_ui/html.py

@@ -17,6 +17,10 @@ def generate_swagger_html(spec: str, js_url: str, css_url: str) -> str:
 <head>
     <meta charset="UTF-8">
     <title>Swagger UI</title>
+    <meta
+      http-equiv="Cache-control"
+      content="no-cache, no-store, must-revalidate"
+    />
     <link rel="stylesheet" type="text/css" href="{css_url}">
 </head>
 
@@ -34,6 +38,9 @@ def generate_swagger_html(spec: str, js_url: str, css_url: str) -> str:
     docExpansion: "list",
     deepLinking: true,
     filter: true,
+    layout: "BaseLayout",
+    showExtensions: true,
+    showCommonExtensions: true,
     spec: JSON.parse(`
         {spec}
     `.trim()),