Fixed Get Logo By ID endpoint to return the image (#183)

* Fixed Get Logo By ID endpoint to return the image * Updated comment * Fixed Open API spec after comments * "Banging head against the wall"
jak103 · Jun 13, 2024 · 9013b6c · 9013b6c
1 parent 5039310
commit 9013b6c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 17 deletions.
diff --git a/backend/internal/server/apis/sports/components/logo.go b/backend/internal/server/apis/sports/components/logo.go
@@ -13,6 +13,7 @@ import (
 func init() {
 	apis.RegisterHandler(fiber.MethodPost, "/logos", auth.Public, handleLogoUpload)
 	apis.RegisterHandler(fiber.MethodGet, "/logos/:id<int>", auth.Public, handleGetLogoByID)
+	// Need to be able to specify ctx.Type (the request's Content-Type) in the RegisterHandler
 }
 
 func handleLogoUpload(c *fiber.Ctx) error {
@@ -57,6 +58,6 @@ func handleGetLogoByID(c *fiber.Ctx) error {
 		return responder.InternalServerError(c)
 	}
 
-	// Send JSON response
-	return responder.OkWithData(c, logo)
+	c.Type("png")
+	return c.Send(logo.Image)
 }
diff --git a/static/oas/v1/sports/components/games.yml b/static/oas/v1/sports/components/games.yml
@@ -44,7 +44,7 @@ paths:
           in: path
           required: true
           schema:
-            type: string
+            type: integer
       responses:
         200:
           description: The response body should contain the game details
@@ -63,7 +63,7 @@ paths:
           in: path
           required: true
           schema:
-            type: string
+            type: integer
       description: Update game details by ID
       requestBody:
         required: true

diff --git a/static/oas/v1/sports/components/logos.yml b/static/oas/v1/sports/components/logos.yml
@@ -4,7 +4,7 @@ paths:
       tags:
         - Logos
       summary: Create Team Logo
-      description: Uploads a team's logo
+      description: Uploads a team's logo. This currently supports png files only.
       requestBody:
         content:
           multipart/form-data:
@@ -13,14 +13,15 @@ paths:
               properties:
                 image:
                   type: string
+                  contentMediaType: image/png
                   format: binary
       responses:
         200:
-          description: Successfully uploaded a team's logo
+          description: OK
           content:
             application/json:
               schema:
-        $ref: '#/components/schemas/PostLogoResponse'
+                $ref: '#/components/schemas/PostLogoResponse'
         400:
           $ref: "../../common/errors.yml#/components/responses/BadRequest"
   /logos/{id}:
@@ -35,18 +36,15 @@ paths:
           required: true
           description: The ID of the logo to retrieve
           schema:
-            type: string
+            type: integer
       responses:
         200:
-          description: The response body should contain the logo binary
+          description: OK
           content:
-            multipart/form-data:
+            image/png:
               schema:
-                type: object
-                properties:
-                  image:
-                    type: string
-                    format: binary
+                type: string
+                format: binary
         400:
           $ref: "../../common/errors.yml#/components/responses/BadRequest"
 

diff --git a/static/oas/v1/sports/components/teams.yml b/static/oas/v1/sports/components/teams.yml
@@ -47,7 +47,7 @@ paths:
           required: true
           description: The ID of the team to retrieve
           schema:
-            type: string
+            type: integer
       responses:
         200:
           description: The response body should contain the list of teams
@@ -68,7 +68,7 @@ paths:
           required: true
           description: The ID of the team to update
           schema:
-            type: string
+            type: integer
       requestBody:
         description: A JSON object with a valid team
         required: true