r/aws_api_gateway_model: suppress schema whitespace differences

[chnorton]

Community Note

• Please vote on this pull request by adding a +1 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Resolves an issue with API Gateway Schema models being marked as having changed when differences solely consist of irrelevant characters such as whitespace.

Implementation ported from service/apigatewayv2/model.go which already handles this issue.

Replaces previous PR #20299.

[github-actions]

Hey @chnorton 👋 Thank you very much for your contribution! At times, our maintainers need to make direct edits to pull requests in order to help get it ready to be merged. Your current settings do not allow maintainers to make such edits. To help facilitate this, update your pull request to allow such edits as described in GitHub's Allowing changes to a pull request branch created from a fork documentation. (If you're using a fork owned by an organization, your organization may not allow you to change this setting. If that is the case, let us know.)

[github-actions]

Welcome @chnorton 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTING guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

[ewbankkit]

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccAPIGatewayModel_' PKG=apigateway ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/apigateway/... -v -count 1 -parallel 2  -run=TestAccAPIGatewayModel_ -timeout 180m
=== RUN   TestAccAPIGatewayModel_basic
=== PAUSE TestAccAPIGatewayModel_basic
=== RUN   TestAccAPIGatewayModel_disappears
=== PAUSE TestAccAPIGatewayModel_disappears
=== CONT  TestAccAPIGatewayModel_basic
=== CONT  TestAccAPIGatewayModel_disappears
--- PASS: TestAccAPIGatewayModel_disappears (16.75s)
--- PASS: TestAccAPIGatewayModel_basic (65.48s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	69.210s

[ewbankkit]

@chnorton Thanks for the contribution 🎉 👏.

[github-actions]

This functionality has been released in v4.20.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[melissarh57]

bummer, this PR with the new schema length enforcement makes things tricky if we have schemas over the length. Any chance to remove the schema length enforcement or increase it?

[varfrog]

I second @melissarh57 's comment. We have an issue that the character length validation caused. We're forced to lock in to version 4.19. Can this be removed or made configurable somehow? @ewbankkit @justinretzolk

[chnorton]

Thank you for raising this @melissarh57 and @varfrog.

Just to explain the intention behind the PR - it is adding the same logic from apigatewayv2 into apigateway so that they're consistent, and included some of the suppression logic from v2.

However, taking another look at the Amazon docs it looks like the string length limits are specific to apigatewayv2 and there are no corresponding limits for apigateway. Very sorry, this was an oversight on my part and I'll look to fix this in a new PR soon.

[chnorton]

Have created 25623 to address this now.

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.