Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(api-gateway): add validation to variables property on Stage resource #25267

Merged
merged 11 commits into from
May 2, 2023

Conversation

sumupitchayan
Copy link
Contributor

Closes #3635

From the original issue: API Gateway Stage variables must match a regex to be valid (See the documentation). When adding variables using CDK, this regex is not enforced, so it can synthesize a CloudFormation template that cannot be deployed.

This PR fixes this issue by adding a validation that the strings match that regex along with a unit test for these changes.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Apr 24, 2023
@gitpod-io
Copy link

gitpod-io bot commented Apr 24, 2023

@aws-cdk-automation aws-cdk-automation requested a review from a team April 24, 2023 16:18
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 24, 2023
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@sumupitchayan sumupitchayan changed the title feat(api-gateway): add validation to variables property on Stage resource fix(api-gateway): add validation to variables property on Stage resource Apr 24, 2023
@sumupitchayan sumupitchayan added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Apr 27, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review April 27, 2023 18:40

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@sumupitchayan sumupitchayan marked this pull request as ready for review April 27, 2023 19:07
@mergify
Copy link
Contributor

mergify bot commented May 2, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 811e599
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 04427e3 into main May 2, 2023
@mergify mergify bot deleted the sumughan/add-validation-variables-prop-api-gateway branch May 2, 2023 15:42
@mergify
Copy link
Contributor

mergify bot commented May 2, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[apigateway] Add validations to the 'variables' property on Stage resource
3 participants