Skip to content

docs(event_handler): enhance documentation on query/header parameters behavior #7000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2025
Merged

docs(event_handler): enhance documentation on query/header parameters behavior #7000

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8be2d
Make clear behavior with query/header validation
leandrodamascena Jul 17, 2025
0dd0eb9
Merge branch 'develop' into doc/improve-enable-validation-doc
leandrodamascena Jul 17, 2025
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
9 changes: 5 additions & 4 deletions docs/core/event_handler/api_gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Event handler for Amazon API Gateway REST and HTTP APIs, Application Load Balanc
* Support for CORS, binary and Gzip compression, Decimals JSON encoding and bring your own JSON serializer
* Built-in integration with [Event Source Data Classes utilities](../../utilities/data_classes.md){target="_blank"} for self-documented event schema
* Works with micro function (one or a few routes) and monolithic functions (all routes)
* Support for OpenAPI and data validation for requests/responses
* Support for OpenAPI schema generation
* Support data validation for requests/responses

## Getting started

Expand Down Expand Up @@ -430,7 +431,7 @@ This value will override the value of the failed response validation http code s

#### Validating query strings

!!! info "We will automatically validate and inject incoming query strings via type annotation."
!!! info "You must set `enable_validation=True` to have access to the incoming query strings parameters via type annotation."

We use the `Annotated` type to tell the Event Handler that a particular parameter is not only an optional string, but also a query string with constraints.

Expand Down Expand Up @@ -490,9 +491,9 @@ For example, we could validate that `<todo_id>` dynamic path should be no greate

#### Validating headers

We use the `Annotated` type to tell the Event Handler that a particular parameter is a header that needs to be validated.
!!! info "You must set `enable_validation=True` to have access to the incoming headers parameters via type annotation."

!!! info "We adhere to [HTTP RFC standards](https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2){target="_blank" rel="nofollow"}, which means we treat HTTP headers as case-insensitive."
We use the `Annotated` type to tell the Event Handler that a particular parameter is a header that needs to be validated. Also, we adhere to [HTTP RFC standards](https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2){target="_blank" rel="nofollow"}, which means we treat HTTP headers as case-insensitive.

In the following example, we use a new `Header` OpenAPI type to add [one out of many possible constraints](#customizing-openapi-parameters), which should read as:

Expand Down