Image Endpoint

exam/api/Users/Image/Image.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Api\Users\Image;
+
+use Exception;
+use Khofmann\Api\Api;
+use Khofmann\Input\Input;
+use Khofmann\Models\User\User;
+use Khofmann\Response\Response;
+use Khofmann\ApiError\ApiError;
+use Khofmann\Request\Request;
+
+class Image extends Api
+{
+  public function post($id): void
+  {
+    // Fetch all inputs.
+    $image = Input::file("image");
+    $predefined = Input::post("predefined");
+
+    // Try and update user image.
+    // Throw errors according to situation.
+    try {
+      Response::json(User::getByID($id)->updateImage($image, $predefined));
+    } catch (Exception $err) {
+      switch ($err->getMessage()) {
+        case "NotFound":
+          throw ApiError::notFound("user");
+        default:
+          // Due to how the failed field is handled, it's ApiError is inside the models update
+          throw $err;
+      }
+    }
+  }
+
+  public function postSelf(): void
+  {
+    // Fetch all inputs.
+    $token = Request::token();
+    $image = Input::file("image");
+    $predefined = Input::post("predefined");
+
+    // Try and update user image.
+    // Throw errors according to situation.
+    try {
+      Response::json(User::getByToken($token)->updateImage($image, $predefined));
+    } catch (Exception $err) {
+      switch ($err->getMessage()) {
+        case "NotFound":
+          throw ApiError::notFound("user");
+        default:
+          // Due to how the failed field is handled, it's ApiError is inside the models update
+          throw $err;
+      }
+    }
+  }
+}

exam/api/docs/api.yaml

@@ -491,7 +491,7 @@ paths:
                 $ref: "#/components/schemas/NotFoundResponse"
               examples:
                 User not found:
-                  value: { "code": "NotFound", "entity": "username" }
+                  value: { "code": "NotFound", "entity": "user" }
         500:
           description: Update failed.
           content:
@@ -539,6 +539,60 @@ paths:
                   value: { "code": "NotFound", "entity": "user" }
       tags:
         - User
+  /users/{id}/image:
+    post:
+      summary: Update user image
+      description: Update user image with ID. <br>
+        Use special ID <code>self</code> to update logged in user. <br>
+        Requires logged in user to have admin permissions for any ID other than <code>self</code>.
+      security:
+        - BasicAuth: []
+        - BasicAuth: [isAdmin]
+      parameters:
+        - name: id
+          in: path
+          description: User ID
+          required: true
+          schema:
+            type: integer
+            format: int14
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UserImageUpdateRequest"
+      responses:
+        200:
+          description: Success.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/UserResponse"
+        404:
+          description: User not found.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotFoundResponse"
+              examples:
+                User not found:
+                  value: { "code": "NotFound", "entity": "user" }
+        500:
+          description: Update failed.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FailedUpdateResponse"
+              examples:
+                Failed username:
+                  value:
+                    {
+                      "code": "FailedUpdate",
+                      "fields": ["image", "predefined"],
+                      "reasons": ["string", "string"],
+                    }
+      tags:
+        - User
 
 externalDocs:
   url: https://khofmann.userpage.fu-berlin.de/phpCourse/exam/api/docs/
@@ -658,6 +712,14 @@ components:
           type: string
         email:
           type: string
+    UserImageUpdateRequest:
+      type: object
+      properties:
+        image:
+          type: string
+          format: binary
+        predefined:
+          type: string
     RegisterRequest:
       type: object
       required: