Allow values other than strings in the examples of the Parameter Object

Author: tonsho

Diff for: aws_lambda_powertools/event_handler/openapi/models.py

@@ -201,7 +201,7 @@ class Schema(BaseModel):
     deprecated: Optional[bool] = None
     readOnly: Optional[bool] = None
     writeOnly: Optional[bool] = None
-    examples: Optional[Union[List["Example"], List[str]]] = None
+    examples: Optional[List[Any]] = None
     # 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

Diff for: tests/functional/event_handler/_pydantic/test_openapi_params.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from datetime import datetime
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel
 from typing_extensions import Annotated
@@ -105,7 +105,7 @@ def test_openapi_with_custom_params():
     def handler(
         count: Annotated[
             int,
-            Query(gt=0, lt=100, examples=[Example(summary="Example 1", value=10)]),
+            Query(gt=0, lt=100, examples=[10]),
         ] = 1,
     ):
         print(count)
@@ -130,8 +130,7 @@ def handler(
     assert parameter.schema_.exclusiveMinimum == 0
     assert parameter.schema_.exclusiveMaximum == 100
     assert len(parameter.schema_.examples) == 1
-    assert parameter.schema_.examples[0].summary == "Example 1"
-    assert parameter.schema_.examples[0].value == 10
+    assert parameter.schema_.examples[0] == 10
 
 
 def test_openapi_with_scalar_returns():
@@ -469,16 +468,26 @@ def test_openapi_with_example_as_list():
     def handler(
         count: Annotated[
             int,
-            Query(gt=0, lt=100, examples=["Example 1"]),
+            Query(gt=0, lt=100, examples=[10]),
         ] = 1,
+        name: Annotated[
+            Optional[str],
+            Query(examples=["Example 1"]),
+        ] = None,
+        include_extra: Annotated[
+            bool,
+            Query(examples=[True]),
+        ] = False,
     ):
         print(count)
+        print(name)
+        print(include_extra)
         raise NotImplementedError()
 
     schema = app.get_openapi_schema()
 
     get = schema.paths["/users"].get
-    assert len(get.parameters) == 1
+    assert len(get.parameters) == 3
     assert get.summary == "Get Users"
     assert get.operationId == "GetUsers"
     assert get.description == "Get paginated users"
@@ -494,4 +503,27 @@ def handler(
     assert parameter.schema_.exclusiveMinimum == 0
     assert parameter.schema_.exclusiveMaximum == 100
     assert len(parameter.schema_.examples) == 1
+    assert parameter.schema_.examples[0] == 10
+
+    parameter = get.parameters[1]
+    assert isinstance(parameter, Parameter)
+    assert parameter.in_ == ParameterInType.query
+    assert parameter.name == "name"
+    assert parameter.required is False
+    assert parameter.schema_.default is None
+    assert len(parameter.schema_.anyOf) == 2
+    assert {i.type for i in parameter.schema_.anyOf} == {"string", "null"}
+    assert parameter.schema_.title == "Name"
+    assert len(parameter.schema_.examples) == 1
     assert parameter.schema_.examples[0] == "Example 1"
+
+    parameter = get.parameters[2]
+    assert isinstance(parameter, Parameter)
+    assert parameter.in_ == ParameterInType.query
+    assert parameter.name == "include_extra"
+    assert parameter.required is False
+    assert parameter.schema_.default is False
+    assert parameter.schema_.type == "boolean"
+    assert parameter.schema_.title == "Include Extra"
+    assert len(parameter.schema_.examples) == 1
+    assert parameter.schema_.examples[0] is True