Skip to content

Commit f47df41

Browse files
committed
docs: add docstring
1 parent 58f5ddb commit f47df41

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

aws_lambda_powertools/event_handler/api_gateway.py

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3156,7 +3156,32 @@ def __init__(
31563156
json_body_deserializer: Callable[[str], dict] | None = None,
31573157
decode_query_parameters: bool = False,
31583158
):
3159-
"""Amazon Application Load Balancer (ALB) resolver"""
3159+
"""Amazon Application Load Balancer (ALB) resolver
3160+
3161+
3162+
Parameters
3163+
----------
3164+
cors: CORSConfig
3165+
Optionally configure and enabled CORS. Not each route will need to have to cors=True
3166+
debug: bool | None
3167+
Enables debug mode, by default False. Can be also be enabled by "POWERTOOLS_DEV"
3168+
environment variable
3169+
serializer: Callable, optional
3170+
function to serialize `obj` to a JSON formatted `str`, by default json.dumps
3171+
strip_prefixes: list[str | Pattern], optional
3172+
optional list of prefixes to be removed from the request path before doing the routing.
3173+
This is often used with api gateways with multiple custom mappings.
3174+
Each prefix can be a static string or a compiled regex pattern
3175+
enable_validation: bool | None
3176+
Enables validation of the request body against the route schema, by default False.
3177+
response_validation_error_http_code
3178+
Sets the returned status code if response is not validated. enable_validation must be True.
3179+
json_body_deserializer: Callable[[str], dict], optional
3180+
function to deserialize `str`, `bytes`, `bytearray` containing a JSON document to a Python `dict`,
3181+
by default json.loads when integrating with EventSource data class
3182+
decode_query_parameters: bool | None
3183+
Enables URL-decoding of query parameters (both keys and values), by default False.
3184+
"""
31603185
super().__init__(
31613186
ProxyEventType.ALBEvent,
31623187
cors,

0 commit comments

Comments
 (0)