Merge pull request quarkusio#42263 from gsmet/fix-rest-config-javadoc

Fix a few typos in newly added REST Client doc
geoand · Aug 1, 2024 · 5a42a77 · 5a42a77
2 parents 7f35270 + e314db8
commit 5a42a77
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/...config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsBuildTimeConfig.java b/...config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsBuildTimeConfig.java
@@ -38,11 +38,11 @@ interface RestClientBuildConfig {
         Optional<String> scope();
 
         /**
-         * If set to true, then Quarkus will ensure that all calls from the rest client go through a local proxy
+         * If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy
          * server (that is managed by Quarkus).
-         * This can be very useful for capturing network traffic to a service that use HTTPS.
+         * This can be very useful for capturing network traffic to a service that uses HTTPS.
          * <p>
-         * This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive
+         * This property is not applicable to the RESTEasy Client, only the Quarkus REST client (formerly RESTEasy Reactive
          * client).
          * <p>
          * This property only applicable to dev and test mode.
@@ -56,7 +56,7 @@ interface RestClientBuildConfig {
          * <p>
          * The algorithm for picking between multiple provider is the following:
          * <ul>
-         * <li>If only the default is around, use it (it's name is {@code default})</li>
+         * <li>If only the default is around, use it (its name is {@code default})</li>
          * <li>If there is only one besides the default, use it</li>
          * <li>If there are multiple ones, fail</li>
          * </ul>

diff --git a/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java b/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java
@@ -28,6 +28,7 @@ public interface RestClientsConfig {
      */
     @WithParentName
     @WithDefaults
+    @ConfigDocMapKey("client")
     Map<String, RestClientConfig> clients();
 
     /**