Docs

2024-07-29 22:06:57 +02:00
parent 5ce2215e44
commit 6a62ae58fc
22 changed files with 670 additions and 7 deletions
@@ -10,8 +10,22 @@ use Khofmann\Response\Response;
 use Khofmann\Models\User\User;
 use Khofmann\Request\Request;

+/**
+ * Refresh route handlers
+ */
 class Refresh extends Api
 {
+  /**
+   * Refresh POST handler
+   *
+   * Refresh a users session. User is retrieved using the authentication `token`.
+   *
+   * Returns user and tokens.
+   *
+   * @throws 401 Missing field
+   * @throws 404 User not found
+   * @throws 500 Failed to refresh tokens
+   */
  public function post(): void
  {
    // Fetch all required inputs.