Add validation for payloadFormatVersion with HTTP APIs #688
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
kstich
requested changes
Jan 11, 2021
...openapi/src/test/java/software/amazon/smithy/aws/apigateway/openapi/AddIntegrationsTest.java
Outdated
Show resolved
Hide resolved
...way-openapi/src/main/java/software/amazon/smithy/aws/apigateway/openapi/AddIntegrations.java
Outdated
Show resolved
Hide resolved
kstich
reviewed
Jan 12, 2021
| ApiGatewayConfig.ApiType apiType = context.getConfig().getExtensions(ApiGatewayConfig.class) | ||
| .getApiGatewayType(); | ||
| if (!trait.getPayloadFormatVersion().isPresent() && apiType.equals(ApiGatewayConfig.ApiType.HTTP)) { | ||
| throw new OpenApiException("When using the HTTP apiGatewayType, a payloadFormatVersion must be set on the" |
There was a problem hiding this comment.
I think this should be clarified a little. It's important here to show the source of the conflict and guide to where this should be fixed.
String.format("When the 'apiGatewayType' OpenAPI conversion setting is 'HTTP', a 'payloadFormatVersion' must "
+ "be set on the aws.apigateway#integration trait applied at %s", trait.getSourceLocation());
Thought I submitted this in the first review, apologies.
There was a problem hiding this comment.
I updated the error message in 9c1f284, but did not include the sourceLocation of the trait. That sourceLocation points back to where the aws.api#integration trait itself was defined, not where it was applied on the service or operation, so it wouldn't be helpful in this case.
kstich
approved these changes
Jan 12, 2021
Merged
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.
HTTP APIs on API Gateway require that the
payloadFormatVersionis set, either to1.0or2.0. This CR adds validation to ensure that when converting to OpenAPI for use with API Gateway, theaws.apigateway#integrationtrait must have this property set when used with an HTTP API. Use with an HTTP API is indicated by setting theapiGatewayTypetoHTTPwhen configuring theopenapiplugin.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.