feat(apigatewayv2): add `description` property for stage by yoyoyo-pg · Pull Request #30820 · aws/aws-cdk

yoyoyo-pg · 2024-07-10T14:38:22Z

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 · 2024-07-10T14:54:44Z

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 · 2024-07-11T13:09:19Z

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

packages/aws-cdk-lib/aws-apigatewayv2/lib/common/stage.ts

go-to-k · 2024-07-12T10:18:14Z

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,
});

Co-authored-by: Kenta Goto (k.goto) <24818752+go-to-k@users.noreply.github.com>

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

go-to-k

Thanks. LGTM.

yoyoyo-pg · 2024-07-13T14:41:50Z

@go-to-k
Thanks for the review!

yoyoyo-pg · 2024-07-16T13:22:42Z

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

gracelu0

LGTM, thank you for contributing!

mergify · 2024-07-22T18:55:11Z

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 · 2024-07-22T18:59:14Z

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 · 2024-07-22T20:28:21Z

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 · 2024-07-22T21:55:58Z

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 · 2024-07-22T21:56:19Z

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.

### 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 - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

aws-cdk-automation · 2024-07-25T17:42:26Z

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.

feat(apigatewayv2): add description poperty for stage

970b232

aws-cdk-automation requested a review from a team July 10, 2024 14:38

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Jul 10, 2024

aws-cdk-automation previously requested changes Jul 10, 2024

View reviewed changes

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Jul 10, 2024

go-to-k suggested changes Jul 10, 2024

View reviewed changes

yoyoyo-pg changed the title ~~feat(apigatewayv2): add description poperty for stage~~ feat(apigatewayv2): add description property for stage Jul 11, 2024

yoyoyo-pg and others added 2 commits July 11, 2024 21:52

delete trailing spaces

a2d3730

Merge branch 'main' into add-apigatewayv2-stage-description

bab6076

yoyoyo-pg requested a review from aws-cdk-automation July 11, 2024 13:02

go-to-k suggested changes Jul 12, 2024

View reviewed changes

packages/aws-cdk-lib/aws-apigatewayv2/lib/common/stage.ts Outdated Show resolved Hide resolved

yoyoyo-pg and others added 2 commits July 13, 2024 11:50

Update packages/aws-cdk-lib/aws-apigatewayv2/lib/common/stage.ts

aaeec9e

Co-authored-by: Kenta Goto (k.goto) <24818752+go-to-k@users.noreply.github.com>

include the property in README

1e5a77f

Merge branch 'main' into add-apigatewayv2-stage-description

1b91de9

go-to-k approved these changes Jul 13, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 13, 2024

github-actions bot mentioned this pull request Jul 15, 2024

Weekly PR metrics report #30858

Closed

yoyoyo-pg closed this Jul 16, 2024

yoyoyo-pg deleted the add-apigatewayv2-stage-description branch July 16, 2024 13:11

yoyoyo-pg restored the add-apigatewayv2-stage-description branch July 16, 2024 13:13

yoyoyo-pg reopened this Jul 16, 2024

Merge branch 'main' into add-apigatewayv2-stage-description

1818c21

gracelu0 previously approved these changes Jul 22, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 22, 2024

Merge branch 'main' into add-apigatewayv2-stage-description

2e9a259

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 22, 2024

gracelu0 approved these changes Jul 22, 2024

View reviewed changes

mergify bot merged commit 8651bbe into aws:main Jul 22, 2024

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 22, 2024

aws locked as resolved and limited conversation to collaborators Jul 25, 2024

Conversation

yoyoyo-pg commented Jul 10, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

yoyoyo-pg commented Jul 10, 2024

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

yoyoyo-pg commented Jul 11, 2024

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

go-to-k commented Jul 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

yoyoyo-pg commented Jul 13, 2024

Uh oh!

yoyoyo-pg commented Jul 16, 2024

Uh oh!

gracelu0 left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Jul 22, 2024

Uh oh!

mergify bot commented Jul 22, 2024

Uh oh!

aws-cdk-automation commented Jul 22, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Jul 22, 2024

Uh oh!

github-actions bot commented Jul 22, 2024

Uh oh!

aws-cdk-automation commented Jul 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

go-to-k commented Jul 12, 2024 •

edited

Loading