Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions aws_lambda_powertools/event_handler/api_gateway.py
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,8 @@ def _openapi_operation_request_body(

# Generate the request body media type
request_media_content: dict[str, Any] = {"schema": body_schema}
if field_info.openapi_examples:
request_media_content["examples"] = field_info.openapi_examples
request_body_oai["content"] = {request_media_type: request_media_content}
return request_body_oai

Expand Down
4 changes: 4 additions & 0 deletions aws_lambda_powertools/event_handler/openapi/params.py
Original file line number Diff line number Diff line change
Expand Up @@ -716,8 +716,12 @@ def __init__(
)
if examples is not None:
kwargs["examples"] = examples
if openapi_examples is not None:
kwargs["openapi_examples"] = openapi_examples
current_json_schema_extra = json_schema_extra or extra

self.openapi_examples = openapi_examples

kwargs.update(
{
"annotation": annotation,
Expand Down
39 changes: 39 additions & 0 deletions tests/functional/event_handler/_pydantic/test_openapi_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,45 @@ def handler(user: Annotated[User, Body(description="This is a user")]):
assert request_body.content[JSON_CONTENT_TYPE].schema_.description == "This is a user"


def test_openapi_with_body_examples():
app = APIGatewayRestResolver()

first_example = Example(summary="Example1", description="Example1", value={"name": "Alice"})
second_example = Example(summary="Example2", description="Example2", value={"name": "Bob"})

class User(BaseModel):
name: str

@app.post("/users")
def handler(
user: Annotated[
User,
Body(
openapi_examples={
"example1": first_example,
"example2": second_example,
},
),
],
):
print(user)

schema = app.get_openapi_schema()
assert len(schema.paths.keys()) == 1

post = schema.paths["/users"].post
assert post.parameters is None
assert post.requestBody is not None

request_body = post.requestBody

# Examples should appear in the request_body content schema
request_body_examples = request_body.content[JSON_CONTENT_TYPE].examples

assert request_body_examples["example1"] == first_example
assert request_body_examples["example2"] == second_example


def test_openapi_with_deprecated_operations():
app = APIGatewayRestResolver()

Expand Down