Skip to content

Commit dad816b

Browse files
Improving documentation and removing unnecessary map
1 parent 1eb03be commit dad816b

File tree

3 files changed

+1
-3
lines changed

3 files changed

+1
-3
lines changed

aws_lambda_powertools/event_handler/openapi/swagger_ui/swagger-ui-bundle.min.js

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

aws_lambda_powertools/event_handler/openapi/swagger_ui/swagger-ui.min.css

Lines changed: 0 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/core/event_handler/api_gateway.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,7 @@ There are some important **caveats** that you should know before enabling it:
485485
| Swagger UI is **publicly accessible by default** | When using `enable_swagger` method, you can [protect sensitive API endpoints by implementing a custom middleware](#customizing-swagger-ui) using your preferred authorization mechanism. |
486486
| **No micro-functions support** yet | Swagger UI is enabled on a per resolver instance which will limit its accuracy here. |
487487
| You need to expose **new routes** | You'll need to expose the following paths to Lambda: `/swagger`, `/swagger.css`, `/swagger.js`; ignore if you're routing all paths already. |
488+
| Problems with **{proxy+}** resource and cache | If you're not using an external CDN for SwaggerUI assets and relying on **Amazon API Gateway cache**, you must specify dedicated paths for `/swagger.js` and `/swagger.css` rather than utilizing `{proxy+}`. |
488489

489490
```python hl_lines="12-13" title="enabling_swagger.py"
490491
--8<-- "examples/event_handler_rest/src/enabling_swagger.py"

0 commit comments

Comments
 (0)