-
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
RestApi: wrong description used for deployments #26148
Labels
bug
This issue is a bug.
effort/small
Small work item – less than a day of effort
p2
package/tools
Related to AWS CDK Tools or CLI
Comments
woltsu
added
bug
This issue is a bug.
needs-triage
This issue or PR still needs to be triaged.
labels
Jun 28, 2023
Yes, we should get it fixed. Thanks for your report. |
pahud
added
p2
effort/small
Small work item – less than a day of effort
and removed
needs-triage
This issue or PR still needs to be triaged.
labels
Jun 28, 2023
Fixed in #26149 😊 |
This was referenced Jul 26, 2023
mergify bot
pushed a commit
that referenced
this issue
Aug 22, 2023
…'s description (#26149) 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: ```tsx const api = new RestApi(this, 'Api', { restApiName: 'MyApi', deployOptions: { description: 'Deployment description' } }); ``` However, looking at the [source code](https://github.com/aws/aws-cdk/blob/72eb1e957afb9d1573445999eddd38b5c345fa7a/packages/aws-cdk-lib/aws-apigateway/lib/restapi.ts#L592C25-L592C25), 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*
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
bug
This issue is a bug.
effort/small
Small work item – less than a day of effort
p2
package/tools
Related to AWS CDK Tools or CLI
Describe the bug
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
.Expected Behavior
It should use the description provided in
deployOptions
Current Behavior
It uses the description of the
RestApi
Reproduction Steps
The created deployment's description will be
My api description
instead ofDeployment description
Possible Solution
No response
Additional Information/Context
No response
CDK CLI Version
2.85.0
Framework Version
No response
Node.js Version
16
OS
Mac
Language
Typescript
Language Version
No response
Other information
No response
The text was updated successfully, but these errors were encountered: