fix(apigateway): deployOptions.description is not used for deployment's description

[woltsu]

When creating an instance of a RestApi construct, by default it has a Deployment attached to it. The description of the Deployment can be configured with an option given to the RestApi, like so:

const api = new RestApi(this, 'Api', {
	restApiName: 'MyApi',
	deployOptions: {
		description: 'Deployment description'
	}
});

However, looking at the source code, we see that instead of using the props.deployOptions.description, it uses props.description.

Fixes #26148

---

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

[gitpod-io]

[aws-cdk-automation]

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.

[yamatatsu]

LGTM

[yamatatsu]

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.

[rix0rrr]

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:

Suggested change

	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',

[yamatatsu]

Reapprovement for changing PR label.

[rix0rrr]

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:

Suggested change

	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',

Pull request has been modified.

Pull request has been modified.

Pull request has been modified.

[mergify]

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 CodeBuild CI Report

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

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

[mergify]

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).