Noting "httpMethod" attribute is for lambda call #875
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When integrating API Gateway with Lambda, "httpMethod" should be "POST" when defining API method is not POST. It is kind to let the reader know it, because some people misunderstood it. see https://forums.aws.amazon.com/thread.jspa?messageID=745275
Codecov Report
@@ Coverage Diff @@
## master #875 +/- ##
=======================================
Coverage 94.54% 94.54%
=======================================
Files 67 67
Lines 2824 2824
Branches 508 508
=======================================
Hits 2670 2670
Misses 81 81
Partials 73 73Continue to review full report at Codecov.
|
Needless to say, "some people" includes me 😃 |
keetonian
approved these changes
Apr 2, 2019
jlhood
approved these changes
Apr 2, 2019
|
|
||
| passthroughBehavior: when_no_match | ||
| httpMethod: POST | ||
| httpMethod: POST # Keep "POST" when the API definition method is not POST. This "httpMethod" is used to call Lambda. |
There was a problem hiding this comment.
Thanks for clarifying this. I've definitely been bitten by this as well. 😅
Consider adding a link to the API Gateway documentation in case someone wants to learn more: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When integrating API Gateway with Lambda, "httpMethod" in swagger.yaml should be "POST" when defining API method is not POST.
It is kind to let the reader know it, because some people misunderstood it.
see https://forums.aws.amazon.com/thread.jspa?messageID=745275
Issue #, if available:
NA
Description of changes:
Add comment on "swagger.yaml" in "examples/2016-10-31/api_swagger_cors"
Description of how you validated changes:
Open edited "swagger.yaml" with https://editor.swagger.io/ and it have no error about edited lines.
Checklist:
make prpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.