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(apigateway): allow overriding apiKeyRequired on methods #25682

Merged
merged 5 commits into from
Jun 5, 2023

Conversation

iRoachie
Copy link
Contributor

RestApi has the ability to set the apiKeyRequired option for all methods via defaultMethodOptions.

Setting this option on a method should override the value set in defaultMethodOptions, but it doesn't work.

This commit fixes the behaviour and adds a test.

Mentioned in #8827


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

RestApi has the ability to set the apiKeyRequired option for all methods via defaultMethodOptions.

Setting this option on a method should override the value set in defaultMethodOptions, but it doesn't work.

This commit fixes the behaviour and adds a test.

Mentioned in aws#8827
@aws-cdk-automation aws-cdk-automation requested a review from a team May 23, 2023 03:00
@gitpod-io
Copy link

gitpod-io bot commented May 23, 2023

@github-actions github-actions bot added admired-contributor [Pilot] contributed between 13-24 PRs to the CDK p2 labels May 23, 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.

@@ -299,7 +299,7 @@ describe('lambda api', () => {
ResourceId: { Ref: 'lambdarestapiproxyE3AE07E3' },
AuthorizationType: 'NONE',
AuthorizerId: Match.absent(),
ApiKeyRequired: Match.absent(),
ApiKeyRequired: false,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should be the correct value given that it's set here

@aws-cdk-automation aws-cdk-automation dismissed their stale review May 23, 2023 03:47

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 23, 2023
@vinayak-kukreja
Copy link
Contributor

Hey, this looks good to me. Thank you for your contributing.

Getting a second opinion from @corymhall.

corymhall
corymhall previously approved these changes Jun 5, 2023
@mergify
Copy link
Contributor

mergify bot commented Jun 5, 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).

@mergify mergify bot dismissed corymhall’s stale review June 5, 2023 12:23

Pull request has been modified.

@mergify
Copy link
Contributor

mergify bot commented Jun 5, 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 aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 5, 2023
@mergify
Copy link
Contributor

mergify bot commented Jun 5, 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: 09968a0
  • 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 ae778cc into aws:main Jun 5, 2023
7 checks passed
@mergify
Copy link
Contributor

mergify bot commented Jun 5, 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).

@iRoachie iRoachie deleted the apikey-override branch June 5, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admired-contributor [Pilot] contributed between 13-24 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants