chore(apigatewayv2): rename 'domainName' to 'name' in the DomainName construct #11989
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…construct C# does not allow a property to have the same name as its class. Jsii works around this by renaming the construct to `_DomainName` which is ugly. Instead, change the property name from `domainName` to `name` and avoid this conflict entirely. Further, re-categorize these class of defects as an error instead of a warning. BREAKING CHANGE: `domainName` property under `DomainName` has been renamed to `name`.
|
|
github-actions
bot
added
the
@aws-cdk/aws-apigatewayv2
NetaNir
reviewed
Dec 10, 2020
| /** | ||
| * The domain name associated with the regional endpoint for this custom domain name. | ||
| */ | ||
| public readonly name: string; |
There was a problem hiding this comment.
why did you remove the docs? Specifically, the @attribute?
There was a problem hiding this comment.
They are automatically inherited from the interface IDomainName.
There was a problem hiding this comment.
This is also why the linter does not complain.
NetaNir
approved these changes
Dec 10, 2020
|
Thank you for contributing! Your pull request will be updated from master 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 |
flochaz
pushed a commit
to flochaz/aws-cdk
that referenced
this pull request
Jan 5, 2021
…construct (aws#11989) C# does not allow a property to have the same name as its class. Jsii works around this by renaming the construct to `_DomainName` which is ugly. Instead, change the property name from `domainName` to `name` and avoid this conflict entirely. Further, re-categorize these class of defects as an error instead of a warning. BREAKING CHANGE: `domainName` property under `DomainName` has been renamed to `name`. ---- *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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
C# does not allow a property to have the same name as its class.
Jsii works around this by renaming the construct to
_DomainNamewhichis ugly.
Instead, change the property name from
domainNametonameand avoidthis conflict entirely.
Further, re-categorize these class of defects as an error instead of a
warning.
BREAKING CHANGE:
domainNameproperty underDomainNamehas beenrenamed to
name.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license