From 79f66a33ece1aabb3312da84d9b3c2f924817134 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Haylee=20Sch=C3=A4fer?= <haylee@inventivetalent.org>
Date: Sun, 9 Jun 2024 13:18:40 +0200
Subject: [PATCH] add example for file upload request

---
 openapi.yml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/openapi.yml b/openapi.yml
index 7087bce2..433aa237 100644
--- a/openapi.yml
+++ b/openapi.yml
@@ -124,6 +124,10 @@ components:
           type: integer
           enum: [ 0, 1 ]
           default: 0
+      example:
+        variant: "classic"
+        name: "My Example Skin"
+        visibility: 0
     UserValidation:
       type: object
       required: [ valid ]
@@ -156,7 +160,7 @@ components:
 
   responses:
     ErrorResponse:
-      description: Response if an error occured
+      description: Response if an error occurred
       content:
         application/json:
           schema:
@@ -238,6 +242,7 @@ paths:
                 - properties:
                     url:
                       type: string
+                      example: "https://i.imgur.com/kQPrtYw.png"
       responses:
         200:
           $ref: '#/components/responses/GeneratedSkin'
@@ -263,8 +268,12 @@ paths:
                 - $ref: '#/components/schemas/GenerateOptions'
                 - properties:
                     file:
+                      description: Image file to upload
                       type: string
                       format: binary
+                      externalDocs:
+                        description: Example implementations
+                        url: https://github.com/MineSkin/examples
       responses:
         200:
           $ref: '#/components/responses/GeneratedSkin'