1
0
Fork 0
mirror of https://github.com/nickpoida/og-aws.git synced 2025-02-14 19:02:00 +00:00

Merge pull request #585 from shtaft/patch-1

Add note on API Gateway query params
This commit is contained in:
Corey Quinn 2018-02-05 14:09:23 -08:00 committed by GitHub
commit 4afb537dc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1477,6 +1477,8 @@ API Gateway
- 🔸Many changes to API Gateway resources need to be 'deployed' via console or API call. Unfortunately, API Gateway is terrible about notifying the user when changes are staged for deployment and what changes require deployment. If you've changed something about your API and it's not taking effect, there's a decent chance you just need to deploy it.
- In particular, when deploying an API Gateway as part of a CloudFormation stack, changes will not automatically deploy unless the deployment resource itself was changed. You can change work around this by always changing the deployment resource on a CloudFormation update, or running a custom resource that ensures the deployment is made.
- Alternatively, by using the [Serverless Application Model](https://github.com/awslabs/serverless-application-model) definition for an API Gateway resource, you can always expect the API to be deployed on a stack update since SAM will generate a new deployment every time.
- 🔸API Gateway does not support nested query parameters on method requests.
🚧 [*Please help expand this incomplete section.*](CONTRIBUTING.md)