Route path parameters only available when using enable_validation=True?

[aalvrz]

I am writing some tests for a route:

from aws_lambda_powertools.event_handler.api_gateway import Router


router = Router()

router.post("/box/<box_id>/send")
def send_box(box_id: str):
    print(box_id)
    # >>> '<box_id>'

I am using the following payload format in my event:

{"pathParameters": {"box_id": "foo"}}

However the value being set for box_id is '<box_id>'. I think this is happening because I am not using enable_validation=True in my APIGatewayRestResolver because I can get the value just fine if I do the following:

router.current_event.path_parameters

>>> {"box_id": "foo"}

I am aware that enable_validation will validate path parameters, but it would be nice if we could still get easy access to them without this setting.

[aalvrz]

Anyone?

[leandrodamascena]

Hey hey @aalvrz! Sorry for super late reply! Gimme until tomorrow and I'll reply this discussion with some detail, ok?

[aalvrz]

@leandrodamascena Sorry I think this was a misunderstanding from my part when writing my unit tests, although I had to spent quite some time trying to figure this out.

Basically I was creating my test event like this:

event = {"path": "/box/<box_id>/send", "httpMethod": "POST", "pathParameters": {"box_id": "foobar"}}

And I thought that was what the resolver expected. But apparently this was the correct way:

event = {"path": f"/box/{my_box_id}/send", "httpMethod": "POST"}

Maybe this needs some more examples in the documentation.

[leandrodamascena]

Hey hey @aalvrz! You're absolutely right, we need to improve our documentation explaining this better!

I'm converting this discussion into an issue to work on this.