From 58823eb3ec21d52bdd75cf2b4fa4dfde3761bf42 Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Fri, 8 Nov 2024 23:42:09 +1300 Subject: [PATCH] Fix javadoc Signed-off-by: Thomas Farr --- java-client/build.gradle.kts | 6 ++++++ .../client/transport/aws/AwsSdk2Transport.java | 12 ++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/java-client/build.gradle.kts b/java-client/build.gradle.kts index 8dc08c2e0..0a6745494 100644 --- a/java-client/build.gradle.kts +++ b/java-client/build.gradle.kts @@ -105,7 +105,13 @@ tasks.withType { tasks.withType().configureEach{ options { + this as StandardJavadocDocletOptions encoding = "UTF-8" + addMultilineStringsOption("tag").setValue(listOf( + "apiNote:a:API Note:", + "implSpec:a:Implementation Requirements:", + "implNote:a:Implementation Note:", + )) } } diff --git a/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java b/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java index f1612c876..7434e290c 100644 --- a/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java +++ b/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java @@ -123,9 +123,9 @@ public AwsSdk2Transport( * {@link AwsSdk2TransportOptions#builder()} and use these to specify non-default credentials, * compression options, etc. * - * @apiNote Using {@code software.amazon.awssdk.http.apache.ApacheHttpClient} is discouraged as it does not support request bodies on GET or DELETE requests. - * This leads to incorrect handling of requests such as {@link OpenSearchClient#clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest)} and {@link OpenSearchClient#deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest)}. - * As such {@link #performRequest(Object, Endpoint, TransportOptions)} & {@link #performRequestAsync(Object, Endpoint, TransportOptions)} will throw a {@link TransportException} if an unsupported request is encountered while using {@code ApacheHttpClient}. + * @implNote Using {@code software.amazon.awssdk.http.apache.ApacheHttpClient} is discouraged as it does not support request bodies on GET or DELETE requests. + * This leads to incorrect handling of requests such as {@link OpenSearchClient#clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest)} and {@link OpenSearchClient#deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest)}. + * As such {@link #performRequest(Object, Endpoint, TransportOptions)} & {@link #performRequestAsync(Object, Endpoint, TransportOptions)} will throw a {@link TransportException} if an unsupported request is encountered while using {@code ApacheHttpClient}. */ public AwsSdk2Transport( @CheckForNull SdkHttpClient syncHttpClient, @@ -171,9 +171,9 @@ public AwsSdk2Transport( * {@link AwsSdk2TransportOptions#builder()} and use these to specify non-default credentials, * compression options, etc. * - * @apiNote Using {@code software.amazon.awssdk.http.apache.ApacheHttpClient} is discouraged as it does not support request bodies on GET or DELETE requests. - * This leads to incorrect handling of requests such as {@link OpenSearchClient#clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest)} and {@link OpenSearchClient#deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest)}. - * As such {@link #performRequest(Object, Endpoint, TransportOptions)} & {@link #performRequestAsync(Object, Endpoint, TransportOptions)} will throw a {@link TransportException} if an unsupported request is encountered while using {@code ApacheHttpClient}. + * @implNote Using {@code software.amazon.awssdk.http.apache.ApacheHttpClient} is discouraged as it does not support request bodies on GET or DELETE requests. + * This leads to incorrect handling of requests such as {@link OpenSearchClient#clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest)} and {@link OpenSearchClient#deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest)}. + * As such {@link #performRequest(Object, Endpoint, TransportOptions)} & {@link #performRequestAsync(Object, Endpoint, TransportOptions)} will throw a {@link TransportException} if an unsupported request is encountered while using {@code ApacheHttpClient}. */ public AwsSdk2Transport( @CheckForNull SdkHttpClient syncHttpClient,