Feature Request: ability to define additional response models in OpenAPI about powertools-lambda-python HOT 5 CLOSED

from typing import Union

from pydantic import BaseModel, Field

from aws_lambda_powertools.event_handler import APIGatewayHttpResolver, Response
from aws_lambda_powertools.event_handler.openapi.types import COMPONENT_REF_PREFIX

app = APIGatewayHttpResolver(enable_validation=True)


class User(BaseModel):
    id_: int = Field(..., alias="id")
    name: str


class Order(BaseModel):
    order_id: int


@app.get(
    "/",
    responses={
        200: {
            "description": "Hello 200",
            "content": {"application/json": {"schema": {"$ref": COMPONENT_REF_PREFIX + "User"}}},
        },
        404: {
            "description": "Hello 404",
            "content": {"application/json": {"schema": {"$ref": COMPONENT_REF_PREFIX + "Order"}}},
        },
    },
)
def put(alternative_return: bool) -> Response[Union[User, Order]]:
    if alternative_return:
        return Response(404, body=Order(order_id=1))
    else:
        return Response(200, body=User(id=3, name="John"))


print(app.get_openapi_json_schema())