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
chore(codegen): include default value comment for service id #4147
chore(codegen): include default value comment for service id #4147
Conversation
affaec6
to
5c72a86
Compare
ServiceShape service = settings.getService(model); | ||
String sdkId = service.getTrait(ServiceTrait.class).map(ServiceTrait::getSdkId) | ||
.orElse(""); | ||
writer.writeDocs(String.format("Unique service identifier.%n@internal%n@default \"%s\"", sdkId)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you run the codegen (yarn generate-clients
) for this and commit it, or want us to do it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought that was done in a separate process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ran the generate-clients script now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i reverted the clients update in order to get this merged
489c08a
to
7b06531
Compare
7b06531
to
226403b
Compare
226403b
to
51a6964
Compare
rebase or open anew if still needed, closing for staleness |
Issue
N/A
Description
This will include the default value as comments for the service identifier.
Testing
Yes, just locally
Additional context
Related to PR #4139. It will allow us to use that value during the documentation generation as shown here:
aws-sdk-js-v3/packages/service-client-documentation-generator/src/sdk-client-rename-project.ts
Lines 26 to 34 in cb102a6
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.