From e44bb89bd89635e68df1f43e5bfa82aaeb6a19c7 Mon Sep 17 00:00:00 2001 From: perp Date: Tue, 4 Jun 2024 16:31:55 +0100 Subject: [PATCH] Added default error response documentation --- internal/router/api/v1/account/login.go | 5 ++--- internal/router/api/v1/account/register.go | 6 ++---- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/internal/router/api/v1/account/login.go b/internal/router/api/v1/account/login.go index aa3a738..9243740 100644 --- a/internal/router/api/v1/account/login.go +++ b/internal/router/api/v1/account/login.go @@ -27,9 +27,8 @@ import ( // @accept json // @produce json // @param register body v1.Register true "alice" "supersecretpassword" -// @success 200 {object} models.Token -// @failure 400 {object} models.Error "MissingBody | InvalidUsername | InvalidPassword" -// @failure 500 {object} models.Error "DatabaseError | InternalServerError" +// @success 200 {object} v1.Token +// @response default {object} v1.Error "There was an error" // @router /v1/account/login [post] func Login(ctx *context.Context) { // Store body diff --git a/internal/router/api/v1/account/register.go b/internal/router/api/v1/account/register.go index a0bf3a6..a526351 100644 --- a/internal/router/api/v1/account/register.go +++ b/internal/router/api/v1/account/register.go @@ -27,10 +27,8 @@ import ( // @accept json // @produce json // @param register body v1.Register true "alice" "supersecretpassword" -// @success 200 {object} models.Token -// @failure 400 {object} models.Error "MissingBody | UsernameTaken" -// @failure 403 {object} models.Error "RegistrationDisabled" -// @failure 500 {object} models.Error "DatabaseError | InternalServerError" +// @success 200 {object} v1.Token +// @response default {object} v1.Error "There was an error" // @router /v1/account/register [post] func Register(ctx *context.Context) { // Check if registration is disabled