#45 - Update javadoc in API using {} style path expressions

Author: rbygrave

http-api/src/main/java/io/avaje/http/api/Default.java

@@ -14,7 +14,7 @@
  *
  * <pre>{@code
  *
- * @Get("/forCustomer/:custId")
+ * @Get("/forCustomer/{custId}")
  * public List<Contact> getContacts(UUID custId, @Default("name") String orderBy) {
  *   ...
  * }

http-api/src/main/java/io/avaje/http/api/Delete.java

@@ -11,7 +11,7 @@
  *
  * <pre>{@code
  *
- *   @Delete(":id")
+ *   @Delete("{id}")
  *   void delete(long id) {
  *
  *     ...

http-api/src/main/java/io/avaje/http/api/Get.java

@@ -11,7 +11,7 @@
  *
  * <pre>{@code
  *
- *   @Get(":id")
+ *   @Get("{id}")
  *   Customer get(long id) {
  *
  *     ...
@@ -30,7 +30,7 @@
  *
  * <pre>{@code
  *
- *   @Get("/status/:status")
+ *   @Get("/status/{status}")
  *   List<Customer> getByStatus(String status, LocalDate since) {
  *
  *     ...
@@ -41,7 +41,7 @@
  * <h4>Example - Multiple path parameters</h4>
  * <pre>{@code
  *
- *   @Get("/status/:status/:parentId")
+ *   @Get("/status/{status}/{parentId}")
  *   List<Customer> getByStatus(String status, long parentId, LocalDate since) {
  *
  *     ...

http-api/src/main/java/io/avaje/http/api/HttpMethod.java

@@ -5,6 +5,9 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Base for Http verb based annotations.
+ */
 @Target(value= ElementType.ANNOTATION_TYPE)
 @Retention(value= RetentionPolicy.RUNTIME)
 public @interface HttpMethod {

http-api/src/main/java/io/avaje/http/api/InvalidPathArgumentException.java

@@ -5,14 +5,23 @@
  */
 public class InvalidPathArgumentException extends InvalidTypeArgumentException {
 
+  /**
+   * Construct with a message.
+   */
   public InvalidPathArgumentException(String message) {
     super(message);
   }
 
+  /**
+   * Construct with an exception.
+   */
   public InvalidPathArgumentException(Exception e) {
     super(e);
   }
 
+  /**
+   * Construct with message and exception.
+   */
   public InvalidPathArgumentException(String message, Exception e) {
     super(message, e);
   }

http-api/src/main/java/io/avaje/http/api/InvalidTypeArgumentException.java

@@ -5,14 +5,23 @@
  */
 public class InvalidTypeArgumentException extends IllegalArgumentException {
 
+  /**
+   * Construct with a message.
+   */
   public InvalidTypeArgumentException(String message) {
     super(message);
   }
 
+  /**
+   * Construct with an exception.
+   */
   public InvalidTypeArgumentException(Exception e) {
     super(e);
   }
 
+  /**
+   * Construct with a message and exception.
+   */
   public InvalidTypeArgumentException(String message, Exception e) {
     super(message, e);
   }

http-api/src/main/java/io/avaje/http/api/RequiredArgumentException.java

@@ -11,15 +11,24 @@ public class RequiredArgumentException extends IllegalArgumentException {
 
   private String property;
 
+  /**
+   * Construct with a message and property.
+   */
   public RequiredArgumentException(String message, String property) {
     super(message);
     this.property = property;
   }
 
+  /**
+   * Construct with an exception.
+   */
   public RequiredArgumentException(Exception e) {
     super(e);
   }
 
+  /**
+   * Construct with a message and exception.
+   */
   public RequiredArgumentException(String message, Exception e) {
     super(message, e);
   }