Apply suggestions from code review

Co-authored-by: Erin Schnabel <[email protected]>
quarkusio · Aug 23, 2021 · 895f686 · 895f686
1 parent c234c9a
commit 895f686
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerCommonProcessor.java b/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerCommonProcessor.java
@@ -137,7 +137,12 @@ static final class ResteasyConfig {
 
         /**
          * Set this to override the default path for JAX-RS resources if there are no
-         * annotated application classes.
+         * annotated application classes. This path is specified with a leading {@literal /}, but is resolved relative
+         *  to {@literal quarkus.http.root-path}.
+         * <ul>
+         * <li>If {@literal quarkus.http.root-path=/} and {@code quarkus.resteasy.path=/bar}, the JAX-RS resource path will be {@literal /bar}</li>
+         * <li>If {@literal quarkus.http.root-path=/bar} and {@code quarkus.resteasy.path=/bar}, the JAX-RS resource path will be {@literal /foo/bar}</li>
+         * </ul>
          */
         @ConfigItem(defaultValue = "/")
         @ConvertWith(NormalizeRootHttpPathConverter.class)

diff --git a/...http/deployment/src/main/java/io/quarkus/vertx/http/deployment/HttpRootPathBuildItem.java b/...http/deployment/src/main/java/io/quarkus/vertx/http/deployment/HttpRootPathBuildItem.java
@@ -73,13 +73,13 @@ public String resolvePath(String path) {
      * <p>
      * Given {@literal quarkus.http.root-path=/}
      * <ul>
-     * <li>{@code resolvePath("foo")} will return {@literal /foo}</li>
-     * <li>{@code resolvePath("/foo")} will return {@literal /foo}</li>
+     * <li>{@code relativePath("foo")} will return {@literal /foo}</li>
+     * <li>{@code relativePath("/foo")} will return {@literal /foo}</li>
      * </ul>
      * Given {@literal quarkus.http.root-path=/app}
      * <ul>
-     * <li>{@code resolvePath("foo")} will return {@literal /app/foo}</li>
-     * <li>{@code resolvePath("/foo")} will return {@literal /app/foo}</li>
+     * <li>{@code relativePath("foo")} will return {@literal /app/foo}</li>
+     * <li>{@code relativePath("/foo")} will return {@literal /app/foo}</li>
      * </ul>
      * <p>
      * The returned path will not end with a slash.