Skip to content

Use HTTPS for AWS API Documentation links in javadocs #2319

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

Use HTTPS for AWS API Documentation links in javadocs #2319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d6f49e
Use HTTPS for AWS API Documentation links in javadocs
Carey-AWS Mar 8, 2021
67ab4f6
Merge github.com:aws/aws-sdk-java-v2
Carey-AWS Mar 10, 2021
5ae035f
Merge github.com:aws/aws-sdk-java-v2
Carey-AWS Mar 10, 2021
f7dda95
Merge branch 'master' of github.com:Carey-AWS/aws-sdk-java-v2
Carey-AWS Mar 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-AWSSDKforJavav2-0ce9c41.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "AWS SDK for Java v2",
"contributor": "Carey-AWS",
"type": "bugfix",
"description": "Use HTTPs for AWS API Documentation links in javadocs"
}
2 changes: 1 addition & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public static String escapeIllegalCharacters(String documentation) {
*/
public static String createLinkToServiceDocumentation(Metadata metadata, String name) {
if (isCrossLinkingEnabledForService(metadata)) {
return String.format("<a href=\"http://%s/goto/WebAPI/%s/%s\" target=\"_top\">AWS API Documentation</a>",
return String.format("<a href=\"https://%s/goto/WebAPI/%s/%s\" target=\"_top\">AWS API Documentation</a>",
AWS_DOCS_HOST,
metadata.getUid(),
name);
Expand Down
28 changes: 14 additions & 14 deletions ...rc/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public final String serviceName() {
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.APostOperation
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/APostOperation" target="_top">AWS
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/APostOperation" target="_top">AWS
* API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -221,7 +221,7 @@ public CompletableFuture<APostOperationResponse> aPostOperation(APostOperationRe
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.APostOperationWithOutput
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/APostOperationWithOutput"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/APostOperationWithOutput"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -278,7 +278,7 @@ public CompletableFuture<APostOperationWithOutputResponse> aPostOperationWithOut
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.EventStreamOperation
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperation"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperation"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -374,7 +374,7 @@ public CompletableFuture<Void> eventStreamOperation(EventStreamOperationRequest
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.EventStreamOperationWithOnlyInput
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperationWithOnlyInput"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperationWithOnlyInput"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -442,7 +442,7 @@ public CompletableFuture<EventStreamOperationWithOnlyInputResponse> eventStreamO
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.EventStreamOperationWithOnlyOutput
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperationWithOnlyOutput"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/EventStreamOperationWithOnlyOutput"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -536,7 +536,7 @@ public CompletableFuture<Void> eventStreamOperationWithOnlyOutput(
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.GetWithoutRequiredMembers
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/GetWithoutRequiredMembers"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/GetWithoutRequiredMembers"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -594,7 +594,7 @@ public CompletableFuture<GetWithoutRequiredMembersResponse> getWithoutRequiredMe
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.OperationWithChecksumRequired
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/OperationWithChecksumRequired"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/OperationWithChecksumRequired"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -655,7 +655,7 @@ public CompletableFuture<OperationWithChecksumRequiredResponse> operationWithChe
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.PaginatedOperationWithResultKey
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithResultKey"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithResultKey"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -765,7 +765,7 @@ public CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOpera
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.PaginatedOperationWithResultKey
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithResultKey"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithResultKey"
* target="_top">AWS API Documentation</a>
*/
public PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyPaginator(
Expand All @@ -790,7 +790,7 @@ public PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyP
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.PaginatedOperationWithoutResultKey
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithoutResultKey"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithoutResultKey"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -900,7 +900,7 @@ public CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedOp
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.PaginatedOperationWithoutResultKey
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithoutResultKey"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/PaginatedOperationWithoutResultKey"
* target="_top">AWS API Documentation</a>
*/
public PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResultKeyPaginator(
Expand Down Expand Up @@ -930,7 +930,7 @@ public PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResu
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.StreamingInputOperation
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingInputOperation"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingInputOperation"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -1003,7 +1003,7 @@ public CompletableFuture<StreamingInputOperationResponse> streamingInputOperatio
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.StreamingInputOutputOperation
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingInputOutputOperation"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingInputOutputOperation"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down Expand Up @@ -1080,7 +1080,7 @@ public <ReturnT> CompletableFuture<ReturnT> streamingInputOutputOperation(
* of this type.</li>
* </ul>
* @sample JsonAsyncClient.StreamingOutputOperation
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingOutputOperation"
* @see <a href="https://docs.aws.amazon.com/goto/WebAPI/json-service-2010-05-08/StreamingOutputOperation"
* target="_top">AWS API Documentation</a>
*/
@Override
Expand Down
Loading