From fed517f9057e4bf8c0f14b403c6a45f683333ffe Mon Sep 17 00:00:00 2001 From: Nikolai Papin Date: Wed, 18 Jun 2025 21:31:39 +0300 Subject: [PATCH] chore: refreshed docs --- backend/cmd/main.go | 24 ++++++++++++------------ backend/docs/docs.go | 2 +- backend/docs/swagger.json | 2 +- backend/docs/swagger.yaml | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/backend/cmd/main.go b/backend/cmd/main.go index f66a4e0..f910425 100644 --- a/backend/cmd/main.go +++ b/backend/cmd/main.go @@ -1,3 +1,15 @@ + // @title Easywish client API + // @version 1.0 + // @description Easy and feature-rich wishlist. + // @license.name GPL 3.0 + + // @BasePath /api/ + // @Schemes http + + // @securityDefinitions.apikey JWT + // @in header + // @name Authorization + package main import ( @@ -23,18 +35,6 @@ func main() { r := gin.Default() r = routes.SetupRoutes(r) - // @title Easywish client API - // @version 1.0 - // @description Easy and feature-rich wishlist. - // @license.name GPL 3.0 - - // @BasePath /api/ - // @Schemes http - - // @securityDefinitions.apikey JWT - // @in header - // @name Authorization - docs.SwaggerInfo.Schemes = []string{"http"} r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler)) diff --git a/backend/docs/docs.go b/backend/docs/docs.go index 386bef8..50d5999 100644 --- a/backend/docs/docs.go +++ b/backend/docs/docs.go @@ -49,7 +49,7 @@ const docTemplate = `{ "tags": [ "Auth" ], - "summary": "Acquire tokens via login credentials or by providing 2FA code", + "summary": "Acquire tokens via login credentials (and 2FA code if needed)", "responses": {} } }, diff --git a/backend/docs/swagger.json b/backend/docs/swagger.json index 82c6c89..4ef2237 100644 --- a/backend/docs/swagger.json +++ b/backend/docs/swagger.json @@ -45,7 +45,7 @@ "tags": [ "Auth" ], - "summary": "Acquire tokens via login credentials or by providing 2FA code", + "summary": "Acquire tokens via login credentials (and 2FA code if needed)", "responses": {} } }, diff --git a/backend/docs/swagger.yaml b/backend/docs/swagger.yaml index f58f691..8774380 100644 --- a/backend/docs/swagger.yaml +++ b/backend/docs/swagger.yaml @@ -32,7 +32,7 @@ paths: produces: - application/json responses: {} - summary: Acquire tokens via login credentials or by providing 2FA code + summary: Acquire tokens via login credentials (and 2FA code if needed) tags: - Auth /auth/passwordResetBegin: