Docs

exam/api/Register/Register.php

@@ -9,8 +9,22 @@ use Khofmann\Input\Input;
 use Khofmann\Response\Response;
 use Khofmann\Models\User\User;
 
+/**
+ * Register route handlers
+ */
 class Register extends Api
 {
+  /**
+   * Register POST handler
+   *
+   * Register a new user. Required inputs are `username`, `email`, and `password`.
+   *
+   * Returns user.
+   *
+   * @throws 400 Missing fields
+   * @throws 400 Duplicate
+   * @throws 404 Failure to create
+   */
   public function post(): void
   {
     // Fetch all required inputs.
@@ -39,6 +53,17 @@ class Register extends Api
     }
   }
 
+  /**
+   * Register PATCH handler
+   *
+   * Confirms a user. Required input is `code`.
+   *
+   * Returns user.
+   *
+   * @throws 400 Missing field
+   * @throws 404 User not found
+   * @throws 404 User already confirmed
+   */
   public function patch(): void
   {
     // Fetch all required inputs.