Add more documentation to @RestHeader

This is needed because otherwise users can get confused about what the actual HTTP header being used Closes: #33861
quarkusio · Jun 7, 2023 · b7df405 · b7df405
1 parent f3bbc25
commit b7df405
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...esteasy-reactive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestHeader.java b/...esteasy-reactive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestHeader.java
@@ -7,6 +7,11 @@
 
 /**
  * Equivalent of HeaderParam but with optional name.
+ * <p>
+ * When the name is not specified, then the parameter name is converted to kebab case
+ * while the first letter of every part of the kebab is made uppercase.
+ * <p>
+ * For example {@code @RestHeader String iAmTheParam} results in the value of the HTTP header {@code I-Am-The-Param} being used.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.FIELD, ElementType.PARAMETER })