chore(codegen): include default value comment for service id #4147
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
eduardomourar
force-pushed
the
chore/include-service-id-default-value
branch
from
affaec6
to
5c72a86
Compare
kuhe
reviewed
Jan 31, 2023
| 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.
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.
I thought that was done in a separate process.
There was a problem hiding this comment.
I ran the generate-clients script now.
There was a problem hiding this comment.
i reverted the clients update in order to get this merged
kuhe
approved these changes
Jan 31, 2023
eduardomourar
force-pushed
the
chore/include-service-id-default-value
branch
from
489c08a
to
7b06531
Compare
eduardomourar
force-pushed
the
chore/include-service-id-default-value
branch
from
7b06531
to
226403b
Compare
eduardomourar
force-pushed
the
chore/include-service-id-default-value
branch
from
226403b
to
51a6964
Compare
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.
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.