-
Notifications
You must be signed in to change notification settings - Fork 4k
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): deployOptions.description is not used for deployment's description #26149
Conversation
…iption instead of the api's description
There was a problem hiding this 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.
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
description: props.description? props.description :'Automatically created by the RestApi construct', | ||
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That make sense.
I found the issue for this imprementation.
#20934
And it say this imprementation is to be able to set the description per deployment.
I think this PR make the imprementation close to customer thinking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is good, but please consider backwards compatibility. This will change the description of all deployments that don't have an explicit description today. This bug has been in here for ~4 years and people have so far been fine with the current behavior.
A safer implementation seems to me:
description: props.description? props.description :'Automatically created by the RestApi construct', | |
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct', | |
description: props.deployOptions?.description ?? props.description ?? 'Automatically created by the RestApi construct', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reapprovement for changing PR label.
description: props.description? props.description :'Automatically created by the RestApi construct', | ||
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is good, but please consider backwards compatibility. This will change the description of all deployments that don't have an explicit description today. This bug has been in here for ~4 years and people have so far been fine with the current behavior.
A safer implementation seems to me:
description: props.description? props.description :'Automatically created by the RestApi construct', | |
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct', | |
description: props.deployOptions?.description ?? props.description ?? 'Automatically created by the RestApi construct', |
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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). |
When creating an instance of a
RestApi
construct, by default it has aDeployment
attached to it. The description of theDeployment
can be configured with an option given to theRestApi
, like so:However, looking at the source code, we see that instead of using the
props.deployOptions.description
, it usesprops.description
.Fixes #26148
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license