From 2aade5d2fe6d694ca232ac676c9b857c86713136 Mon Sep 17 00:00:00 2001
From: Imbus <>
Date: Mon, 18 Mar 2024 19:59:14 +0100
Subject: [PATCH] Docs example

---
 backend/docs/docs.go                          | 24 +++++++++++++++++++
 .../handlers/handlers_user_related.go         |  7 +++---
 2 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/backend/docs/docs.go b/backend/docs/docs.go
index 8026f58..75908b4 100644
--- a/backend/docs/docs.go
+++ b/backend/docs/docs.go
@@ -32,6 +32,17 @@ const docTemplate = `{
                     "User"
                 ],
                 "summary": "Register a new user",
+                "parameters": [
+                    {
+                        "description": "User to register",
+                        "name": "{string}",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/types.NewUser"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "User added",
@@ -55,6 +66,19 @@ const docTemplate = `{
             }
         }
     },
+    "definitions": {
+        "types.NewUser": {
+            "type": "object",
+            "properties": {
+                "password": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string"
+                }
+            }
+        }
+    },
     "externalDocs": {
         "description": "OpenAPI",
         "url": "https://swagger.io/resources/open-api/"
diff --git a/backend/internal/handlers/handlers_user_related.go b/backend/internal/handlers/handlers_user_related.go
index 0f7c047..e454f9f 100644
--- a/backend/internal/handlers/handlers_user_related.go
+++ b/backend/internal/handlers/handlers_user_related.go
@@ -16,9 +16,10 @@ import (
 //	@Tags			User
 //	@Accept			json
 //	@Produce		json
-//	@Success		200	{string}	string	"User added"
-//	@Failure		400	{string}	string	"Bad request"
-//	@Failure		500	{string}	string	"Internal server error"
+//	@Param			{string}	body		types.NewUser	true	"User to register"
+//	@Success		200			{string}	string			"User added"
+//	@Failure		400			{string}	string			"Bad request"
+//	@Failure		500			{string}	string			"Internal server error"
 //	@Router			/api/register [post]
 func (gs *GState) Register(c *fiber.Ctx) error {
 	u := new(types.NewUser)