Skip to content

Commit f66d01a

Browse files
committed
docs: add initial skeleton
1 parent 213caed commit f66d01a

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/core/event_handler/api_gateway.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: API Gateway
33
description: Core utility
44
---
55

6-
Event handler for AWS API Gateway and Application Loader Balancers.
6+
Event handler for AWS API Gateway and Application Loader Balancer (ALB).
7+
8+
!!! todo "Change proxy types enum to match PascalCase"
79

810
### Key Features
911

@@ -17,6 +19,28 @@ Event handler for AWS API Gateway and Application Loader Balancers.
1719
* Support function returns a Response object which give fine-grained control of the headers
1820
* JSON encoding of Decimals
1921

22+
## Getting started
23+
24+
!!! todo "Supported event types"
25+
26+
### Required resources
27+
28+
!!! todo "API Gateway proxy template"
29+
30+
### Resolver decorator
31+
32+
### Path expressions
33+
34+
### CORS
35+
36+
## Advanced
37+
38+
### Fine grained responses
39+
40+
### Binary responses
41+
42+
### Testing your code
43+
2044
## Examples
2145

2246
> TODO - Break on into smaller examples

0 commit comments

Comments
 (0)