From e3d9650f70e7d92ece5bb8ad0bf297d41b1f9a54 Mon Sep 17 00:00:00 2001 From: Carey Burgess Date: Thu, 4 Mar 2021 08:39:10 -0800 Subject: [PATCH] Use HTTPS for AWS API Documentation links in javadocs --- .changes/bugfix-AWSSDKforJavav2-f23eb45.json | 6 ++ .../codegen/internal/DocumentationUtils.java | 2 +- .../poet/client/test-async-client-class.java | 28 ++++---- .../test-json-async-client-interface.java | 72 +++++++++---------- .../poet/client/test-json-client-class.java | 22 +++--- .../client/test-query-async-client-class.java | 10 +-- .../poet/client/test-query-client-class.java | 10 +-- .../client/test-xml-async-client-class.java | 10 +-- 8 files changed, 83 insertions(+), 77 deletions(-) create mode 100644 .changes/bugfix-AWSSDKforJavav2-f23eb45.json diff --git a/.changes/bugfix-AWSSDKforJavav2-f23eb45.json b/.changes/bugfix-AWSSDKforJavav2-f23eb45.json new file mode 100644 index 000000000000..c9d6751837bd --- /dev/null +++ b/.changes/bugfix-AWSSDKforJavav2-f23eb45.json @@ -0,0 +1,6 @@ +{ + "type": "bugfix", + "category": "AWS SDK for Java v2", + "contributor": "Carey-AWS", + "description": "Use HTTPS for AWS API Documentation links in javadocs" +} diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java b/codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java index 93bc7e4bbe3d..e21e6057e73e 100644 --- a/codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java +++ b/codegen/src/main/java/software/amazon/awssdk/codegen/internal/DocumentationUtils.java @@ -114,7 +114,7 @@ public static String escapeIllegalCharacters(String documentation) { */ public static String createLinkToServiceDocumentation(Metadata metadata, String name) { if (isCrossLinkingEnabledForService(metadata)) { - return String.format("AWS API Documentation", + return String.format("AWS API Documentation", AWS_DOCS_HOST, metadata.getUid(), name); diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java index fe8166aa8c83..44b7b9664c32 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java @@ -157,7 +157,7 @@ public final String serviceName() { * of this type. * * @sample JsonAsyncClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ @Override @@ -221,7 +221,7 @@ public CompletableFuture aPostOperation(APostOperationRe * of this type. * * @sample JsonAsyncClient.APostOperationWithOutput - * @see AWS API Documentation */ @Override @@ -278,7 +278,7 @@ public CompletableFuture aPostOperationWithOut * of this type. * * @sample JsonAsyncClient.EventStreamOperation - * @see AWS API Documentation */ @Override @@ -374,7 +374,7 @@ public CompletableFuture eventStreamOperation(EventStreamOperationRequest * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyInput - * @see AWS API Documentation */ @Override @@ -442,7 +442,7 @@ public CompletableFuture eventStreamO * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyOutput - * @see AWS API Documentation */ @Override @@ -536,7 +536,7 @@ public CompletableFuture eventStreamOperationWithOnlyOutput( * of this type. * * @sample JsonAsyncClient.GetWithoutRequiredMembers - * @see AWS API Documentation */ @Override @@ -594,7 +594,7 @@ public CompletableFuture getWithoutRequiredMe * of this type. * * @sample JsonAsyncClient.OperationWithChecksumRequired - * @see AWS API Documentation */ @Override @@ -655,7 +655,7 @@ public CompletableFuture operationWithChe * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ @Override @@ -765,7 +765,7 @@ public CompletableFuture paginatedOpera * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ public PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyPaginator( @@ -790,7 +790,7 @@ public PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyP * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ @Override @@ -900,7 +900,7 @@ public CompletableFuture paginatedOp * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ public PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResultKeyPaginator( @@ -930,7 +930,7 @@ public PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResu * of this type. * * @sample JsonAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ @Override @@ -1003,7 +1003,7 @@ public CompletableFuture streamingInputOperatio * of this type. * * @sample JsonAsyncClient.StreamingInputOutputOperation - * @see AWS API Documentation */ @Override @@ -1080,7 +1080,7 @@ public CompletableFuture streamingInputOutputOperation( * of this type. * * @sample JsonAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ @Override diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java index 43455c17f37e..64dff6752896 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java @@ -83,7 +83,7 @@ static JsonAsyncClientBuilder builder() { * of this type. * * @sample JsonAsyncClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ default CompletableFuture aPostOperation(APostOperationRequest aPostOperationRequest) { @@ -116,7 +116,7 @@ default CompletableFuture aPostOperation(APostOperationR * of this type. * * @sample JsonAsyncClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ default CompletableFuture aPostOperation(Consumer aPostOperationRequest) { @@ -143,7 +143,7 @@ default CompletableFuture aPostOperation(Consumer * * @sample JsonAsyncClient.APostOperationWithOutput - * @see AWS API Documentation */ default CompletableFuture aPostOperationWithOutput( @@ -178,7 +178,7 @@ default CompletableFuture aPostOperationWithOu * of this type. * * @sample JsonAsyncClient.APostOperationWithOutput - * @see AWS API Documentation */ default CompletableFuture aPostOperationWithOutput( @@ -203,7 +203,7 @@ default CompletableFuture aPostOperationWithOu * of this type. * * @sample JsonAsyncClient.EventStreamOperation - * @see AWS API Documentation */ default CompletableFuture eventStreamOperation(EventStreamOperationRequest eventStreamOperationRequest, @@ -233,7 +233,7 @@ default CompletableFuture eventStreamOperation(EventStreamOperationRequest * of this type. * * @sample JsonAsyncClient.EventStreamOperation - * @see AWS API Documentation */ default CompletableFuture eventStreamOperation( @@ -260,7 +260,7 @@ default CompletableFuture eventStreamOperation( * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyInput - * @see AWS API Documentation */ default CompletableFuture eventStreamOperationWithOnlyInput( @@ -292,7 +292,7 @@ default CompletableFuture eventStream * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyInput - * @see AWS API Documentation */ default CompletableFuture eventStreamOperationWithOnlyInput( @@ -320,7 +320,7 @@ default CompletableFuture eventStream * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyOutput - * @see AWS API Documentation */ default CompletableFuture eventStreamOperationWithOnlyOutput( @@ -352,7 +352,7 @@ default CompletableFuture eventStreamOperationWithOnlyOutput( * of this type. * * @sample JsonAsyncClient.EventStreamOperationWithOnlyOutput - * @see AWS API Documentation */ default CompletableFuture eventStreamOperationWithOnlyOutput( @@ -383,7 +383,7 @@ default CompletableFuture eventStreamOperationWithOnlyOutput( * of this type. * * @sample JsonAsyncClient.GetWithoutRequiredMembers - * @see AWS API Documentation */ default CompletableFuture getWithoutRequiredMembers( @@ -418,7 +418,7 @@ default CompletableFuture getWithoutRequiredM * of this type. * * @sample JsonAsyncClient.GetWithoutRequiredMembers - * @see AWS API Documentation */ default CompletableFuture getWithoutRequiredMembers( @@ -444,7 +444,7 @@ default CompletableFuture getWithoutRequiredM * of this type. * * @sample JsonAsyncClient.OperationWithChecksumRequired - * @see AWS API Documentation */ default CompletableFuture operationWithChecksumRequired( @@ -475,7 +475,7 @@ default CompletableFuture operationWithCh * of this type. * * @sample JsonAsyncClient.OperationWithChecksumRequired - * @see AWS API Documentation */ default CompletableFuture operationWithChecksumRequired( @@ -501,7 +501,7 @@ default CompletableFuture operationWithCh * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default CompletableFuture paginatedOperationWithResultKey( @@ -532,7 +532,7 @@ default CompletableFuture paginatedOper * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default CompletableFuture paginatedOperationWithResultKey( @@ -557,7 +557,7 @@ default CompletableFuture paginatedOper * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default CompletableFuture paginatedOperationWithResultKey() { @@ -632,7 +632,7 @@ default CompletableFuture paginatedOper * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyPaginator() { @@ -708,7 +708,7 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyPaginator( @@ -791,7 +791,7 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKeyPaginator( @@ -817,7 +817,7 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ default CompletableFuture paginatedOperationWithoutResultKey( @@ -848,7 +848,7 @@ default CompletableFuture paginatedO * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ default CompletableFuture paginatedOperationWithoutResultKey( @@ -926,7 +926,7 @@ default CompletableFuture paginatedO * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResultKeyPaginator( @@ -1009,7 +1009,7 @@ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutRes * of this type. * * @sample JsonAsyncClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutResultKeyPaginator( @@ -1039,7 +1039,7 @@ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutRes * of this type. * * @sample JsonAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOperation( @@ -1074,7 +1074,7 @@ default CompletableFuture streamingInputOperati * of this type. * * @sample JsonAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOperation( @@ -1104,7 +1104,7 @@ default CompletableFuture streamingInputOperati * of this type. * * @sample JsonAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOperation( @@ -1139,7 +1139,7 @@ default CompletableFuture streamingInputOperati * of this type. * * @sample JsonAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOperation( @@ -1174,7 +1174,7 @@ default CompletableFuture streamingInputOperati * of this type. * * @sample JsonAsyncClient.StreamingInputOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOutputOperation( @@ -1215,7 +1215,7 @@ default CompletableFuture streamingInputOutputOperation( * of this type. * * @sample JsonAsyncClient.StreamingInputOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOutputOperation( @@ -1252,7 +1252,7 @@ default CompletableFuture streamingInputOutputOperation( * of this type. * * @sample JsonAsyncClient.StreamingInputOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOutputOperation( @@ -1292,7 +1292,7 @@ default CompletableFuture streamingInputO * of this type. * * @sample JsonAsyncClient.StreamingInputOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingInputOutputOperation( @@ -1324,7 +1324,7 @@ default CompletableFuture streamingInputO * of this type. * * @sample JsonAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingOutputOperation( @@ -1360,7 +1360,7 @@ default CompletableFuture streamingOutputOperation( * of this type. * * @sample JsonAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingOutputOperation( @@ -1390,7 +1390,7 @@ default CompletableFuture streamingOutputOperation( * of this type. * * @sample JsonAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingOutputOperation( @@ -1424,7 +1424,7 @@ default CompletableFuture streamingOutputOpera * of this type. * * @sample JsonAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ default CompletableFuture streamingOutputOperation( diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-class.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-class.java index b1c99a29788f..21fca5a0be3a 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-class.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-class.java @@ -112,7 +112,7 @@ public final String serviceName() { * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ @Override @@ -165,7 +165,7 @@ public APostOperationResponse aPostOperation(APostOperationRequest aPostOperatio * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.APostOperationWithOutput - * @see AWS API Documentation */ @Override @@ -216,7 +216,7 @@ public APostOperationWithOutputResponse aPostOperationWithOutput( * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.GetWithoutRequiredMembers - * @see AWS API Documentation */ @Override @@ -263,7 +263,7 @@ public GetWithoutRequiredMembersResponse getWithoutRequiredMembers( * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.OperationWithChecksumRequired - * @see AWS API Documentation */ @Override @@ -314,7 +314,7 @@ public OperationWithChecksumRequiredResponse operationWithChecksumRequired( * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ @Override @@ -416,7 +416,7 @@ public PaginatedOperationWithResultKeyResponse paginatedOperationWithResultKey( * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.PaginatedOperationWithResultKey - * @see AWS API Documentation */ @Override @@ -439,7 +439,7 @@ public PaginatedOperationWithResultKeyIterable paginatedOperationWithResultKeyPa * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ @Override @@ -541,7 +541,7 @@ public PaginatedOperationWithoutResultKeyResponse paginatedOperationWithoutResul * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.PaginatedOperationWithoutResultKey - * @see AWS API Documentation */ @Override @@ -576,7 +576,7 @@ public PaginatedOperationWithoutResultKeyIterable paginatedOperationWithoutResul * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.StreamingInputOperation - * @see AWS API Documentation */ @Override @@ -646,7 +646,7 @@ public StreamingInputOperationResponse streamingInputOperation(StreamingInputOpe * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.StreamingInputOutputOperation - * @see AWS API Documentation */ @Override @@ -711,7 +711,7 @@ public ReturnT streamingInputOutputOperation( * @throws JsonException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample JsonClient.StreamingOutputOperation - * @see AWS API Documentation */ @Override diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-async-client-class.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-async-client-class.java index 7255486fa623..1ec70b053939 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-async-client-class.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-async-client-class.java @@ -104,7 +104,7 @@ public final String serviceName() { * instance of this type. * * @sample QueryAsyncClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ @Override @@ -163,7 +163,7 @@ public CompletableFuture aPostOperation(APostOperationRe * instance of this type. * * @sample QueryAsyncClient.APostOperationWithOutput - * @see AWS API Documentation */ @Override @@ -218,7 +218,7 @@ public CompletableFuture aPostOperationWithOut * instance of this type. * * @sample QueryAsyncClient.OperationWithChecksumRequired - * @see AWS API Documentation */ @Override @@ -280,7 +280,7 @@ public CompletableFuture operationWithChe * instance of this type. * * @sample QueryAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ @Override @@ -345,7 +345,7 @@ public CompletableFuture streamingInputOperatio * instance of this type. * * @sample QueryAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ @Override diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-client-class.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-client-class.java index ba0c0d5306fd..05334f3462a7 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-client-class.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-query-client-class.java @@ -88,7 +88,7 @@ public final String serviceName() { * @throws QueryException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample QueryClient.APostOperation - * @see AWS + * @see AWS * API Documentation */ @Override @@ -136,7 +136,7 @@ public APostOperationResponse aPostOperation(APostOperationRequest aPostOperatio * @throws QueryException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample QueryClient.APostOperationWithOutput - * @see AWS API Documentation */ @Override @@ -180,7 +180,7 @@ public APostOperationWithOutputResponse aPostOperationWithOutput( * @throws QueryException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample QueryClient.OperationWithChecksumRequired - * @see AWS API Documentation */ @Override @@ -239,7 +239,7 @@ public OperationWithChecksumRequiredResponse operationWithChecksumRequired( * @throws QueryException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample QueryClient.StreamingInputOperation - * @see AWS API Documentation */ @Override @@ -295,7 +295,7 @@ public StreamingInputOperationResponse streamingInputOperation(StreamingInputOpe * @throws QueryException * Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type. * @sample QueryClient.StreamingOutputOperation - * @see AWS API Documentation */ @Override diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-xml-async-client-class.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-xml-async-client-class.java index 6a2f904ad448..8f3b3a5f3929 100644 --- a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-xml-async-client-class.java +++ b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-xml-async-client-class.java @@ -101,7 +101,7 @@ public final String serviceName() { * of this type. * * @sample XmlAsyncClient.APostOperation - * @see AWS API + * @see AWS API * Documentation */ @Override @@ -158,7 +158,7 @@ public CompletableFuture aPostOperation(APostOperationRe * of this type. * * @sample XmlAsyncClient.APostOperationWithOutput - * @see AWS API Documentation */ @Override @@ -212,7 +212,7 @@ public CompletableFuture aPostOperationWithOut * of this type. * * @sample XmlAsyncClient.OperationWithChecksumRequired - * @see AWS API Documentation */ @Override @@ -272,7 +272,7 @@ public CompletableFuture operationWithChe * of this type. * * @sample XmlAsyncClient.StreamingInputOperation - * @see AWS API Documentation */ @Override @@ -336,7 +336,7 @@ public CompletableFuture streamingInputOperatio * of this type. * * @sample XmlAsyncClient.StreamingOutputOperation - * @see AWS API Documentation */ @Override