Add documentationIdentifier value to aws.api#service trait #1863
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
Add documentationIdentifier value to aws.api#service trait. This value is used to implement linking between service and sdk documentation for AWS services.
|
documentationIdentifier seems like it could be made shorter - docId? |
JordonPhillips
requested changes
Jul 19, 2023
| * @param target the ShapeId targeted by the trait. | ||
| * @return Returns the builder. | ||
| */ | ||
| public Builder target(ShapeId target) { |
There was a problem hiding this comment.
this will always be overwritten
There was a problem hiding this comment.
Not if I build the object without passing a ShapeId to the builder, such as serviceTrait.toBuilder().build(). I can make it private though (:
smithy-aws-traits/src/main/java/software/amazon/smithy/aws/traits/ServiceTrait.java
Outdated
Show resolved
Hide resolved
JordonPhillips
approved these changes
Jul 20, 2023
kstich
reviewed
Jul 20, 2023
| .. _service-doc-id: | ||
|
|
||
| ``docId`` | ||
| =========================== |
There was a problem hiding this comment.
Header line should match the length of the header string.
| .. _service-doc-id: | ||
|
|
||
| ``docId`` | ||
| =========================== |
There was a problem hiding this comment.
Header line should match the length of the header string.
| * @return Returns the documentation identifier value for the service name. | ||
| */ | ||
| public String getDocId(Model model) { | ||
| return getDocId().orElse(buildDefaultDocId(model)); |
There was a problem hiding this comment.
minor: This should use orElseGet with a Supplier that returns the value currently place. Otherwise, the buildDefaultDocId method is called even when getDocId() has a value.
syall
pushed a commit
to Xtansia/smithy
that referenced
this pull request
Aug 11, 2023
Add docId property to aws.api#service trait. This value is used to implement linking between service and sdk documentation for AWS services.
alextwoods
pushed a commit
to alextwoods/smithy
that referenced
this pull request
Sep 15, 2023
Add docId property to aws.api#service trait. This value is used to implement linking between service and sdk documentation for AWS services.
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.
Description of changes: Add documentationIdentifier value to aws.api#service trait. This value is used to implement linking between service and sdk documentation for AWS services.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.