Add payloadFormatVersion to API Gateway Integration trait. #527
Conversation
This file contains 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
Currently, when converting the Smithy model to API Gateway for HTTP APIs, it fails because it doesn't configure the `payloadFormatVersion`. This change adds the payload format version to the IntegrationTrait. The payload format version specifies the format of the data that API Gateway sends to an integration, and how API Gateway interprets the response. If you create an integration for HTTP APIs programmatically, you **must** specify a payloadFormatVersion. The supported values are 1.0 and 2.0.
mtdowling
requested changes
Aug 13, 2020
There was a problem hiding this comment.
Can you add this new property to the trait definition too? https://github.com/awslabs/smithy/blob/master/smithy-aws-apigateway-traits/src/main/resources/META-INF/smithy/aws.apigateway.json#L124
Sorry, forgot about that one. Added it to the trait definition now + modified the documentation. Thanks |
mtdowling
approved these changes
Aug 14, 2020
srchase
approved these changes
Aug 14, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, when converting the Smithy model to API Gateway for HTTP APIs, it fails because it doesn't configure the
payloadFormatVersion. This change adds the payload format version to the IntegrationTrait.The payload format version specifies the format of the data that API Gateway sends to an integration, and how API Gateway interprets the response. If you create an integration for HTTP APIs programmatically, you must specify a payloadFormatVersion. The supported values are 1.0 and 2.0.
Issue #, if available: No issue #
Description of changes: See commit message above. Added the payloadFormatVersion that is required as document here: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.