feat(apigatewayv2): add description property for stage

[yoyoyo-pg]

Issue # (if applicable)

Reason for this change

The description property existed in the L1 construct but was not present in the L2 construct

Description of changes

Add the description property for HttpStage and WebSocketStage, which was missing in the L2 construct.

Description of how you validated changes

I Added both unit test and integration tests.

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

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

[yoyoyo-pg]

Exemption Request: It is possible to specify the description option when defining CfnApi as well, but there is no description in the apigatewayv2 README.
I don't think it is necessary to include a description for CfnStage as well as for CfnApi.

[go-to-k]

Thanks for this PR! It seems that the PR title has a typo poperty.
There are also errors in the Code Build CI. Could you please check the trailing spaces, and erase them?

aws-cdk-lib: /codebuild/output/src284929355/src/github.com/aws/aws-cdk/packages/aws-cdk-lib/aws-apigatewayv2/lib/common/stage.ts
aws-cdk-lib:   72:5  error  Trailing spaces not allowed  no-trailing-spaces
aws-cdk-lib: /codebuild/output/src284929355/src/github.com/aws/aws-cdk/packages/aws-cdk-lib/aws-apigatewayv2/test/websocket/stage.test.ts
aws-cdk-lib:   148:1  error  Trailing spaces not allowed  no-trailing-spaces
aws-cdk-lib: 笨� 2 problems (2 errors, 0 warnings)
aws-cdk-lib:   2 errors and 0 warnings 

[yoyoyo-pg]

@go-to-k
Thank you! I have modified the title of the pull request and removed the trailing space.

[go-to-k]

It's very nice. I made just a few minor comments.

[go-to-k]

Exemption Request: It is possible to specify the description option when defining CfnApi as well, but there is no description in the apigatewayv2 README.
I don't think it is necessary to include a description for CfnStage as well as for CfnApi.

Both the WebSocketStage and the HttpStage seem to be in the README. Could you include the property in the sample code?

https://github.com/go-to-k/aws-cdk/blob/7cd0f65a669abf5144a705fec0652f3b550a9340/packages/aws-cdk-lib/aws-apigatewayv2/README.md#publishing-http-apis

declare const api: apigwv2.HttpApi;

new apigwv2.HttpStage(this, 'Stage', {
  httpApi: api,
  stageName: 'beta',
  description: 'My Stage', // <- here
});

https://github.com/go-to-k/aws-cdk/blob/7cd0f65a669abf5144a705fec0652f3b550a9340/packages/aws-cdk-lib/aws-apigatewayv2/README.md#websocket-api

import { WebSocketLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';
// ...
// ...
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  description: 'My Stage', // <- here
  autoDeploy: true,
});

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

[go-to-k]

Thanks. LGTM.

[yoyoyo-pg]

@go-to-k
Thanks for the review!

[yoyoyo-pg]

I'm sorry. I deleted the branch by mistake and reopened the pull request.

[gracelu0]

LGTM, thank you for contributing!

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

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

Pull request has been modified.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 2e9a259
• 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).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[aws-cdk-automation]

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.