From 54e37e59fc33c527225ab50950730f96d8263e32 Mon Sep 17 00:00:00 2001 From: Kharec Date: Sun, 23 Nov 2025 13:35:00 +0100 Subject: [PATCH] docs: update swagger --- docs/docs.go | 92 +++++++++++++++++++++++++++++++++++++++-------- docs/swagger.json | 92 +++++++++++++++++++++++++++++++++++++++-------- docs/swagger.yaml | 51 ++++++++++++++++++++++++++ 3 files changed, 205 insertions(+), 30 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index c6b7ce1..77de3dd 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1819,6 +1819,9 @@ const docTemplate = `{ "definitions": { "dto.ConfirmAccountDeletionRequest": { "type": "object", + "required": [ + "token" + ], "properties": { "delete_posts": { "type": "boolean" @@ -1830,20 +1833,30 @@ const docTemplate = `{ }, "dto.CreatePostRequest": { "type": "object", + "required": [ + "url" + ], "properties": { "content": { - "type": "string" + "type": "string", + "maxLength": 10000 }, "title": { - "type": "string" + "type": "string", + "maxLength": 200, + "minLength": 3 }, "url": { - "type": "string" + "type": "string", + "maxLength": 2048 } } }, "dto.ForgotPasswordRequest": { "type": "object", + "required": [ + "username_or_email" + ], "properties": { "username_or_email": { "type": "string" @@ -1852,12 +1865,20 @@ const docTemplate = `{ }, "dto.LoginRequest": { "type": "object", + "required": [ + "password", + "username" + ], "properties": { "password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, @@ -1875,31 +1896,51 @@ const docTemplate = `{ }, "dto.RegisterRequest": { "type": "object", + "required": [ + "email", + "password", + "username" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 }, "password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, "dto.ResendVerificationRequest": { "type": "object", + "required": [ + "email" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 } } }, "dto.ResetPasswordRequest": { "type": "object", + "required": [ + "new_password", + "token" + ], "properties": { "new_password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "token": { "type": "string" @@ -1920,39 +1961,60 @@ const docTemplate = `{ }, "dto.UpdateEmailRequest": { "type": "object", + "required": [ + "email" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 } } }, "dto.UpdatePasswordRequest": { "type": "object", + "required": [ + "current_password", + "new_password" + ], "properties": { "current_password": { "type": "string" }, "new_password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 } } }, "dto.UpdatePostRequest": { "type": "object", + "required": [ + "title" + ], "properties": { "content": { - "type": "string" + "type": "string", + "maxLength": 10000 }, "title": { - "type": "string" + "type": "string", + "maxLength": 200, + "minLength": 3 } } }, "dto.UpdateUsernameRequest": { "type": "object", + "required": [ + "username" + ], "properties": { "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, diff --git a/docs/swagger.json b/docs/swagger.json index 2a65f18..272d1d3 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1816,6 +1816,9 @@ "definitions": { "dto.ConfirmAccountDeletionRequest": { "type": "object", + "required": [ + "token" + ], "properties": { "delete_posts": { "type": "boolean" @@ -1827,20 +1830,30 @@ }, "dto.CreatePostRequest": { "type": "object", + "required": [ + "url" + ], "properties": { "content": { - "type": "string" + "type": "string", + "maxLength": 10000 }, "title": { - "type": "string" + "type": "string", + "maxLength": 200, + "minLength": 3 }, "url": { - "type": "string" + "type": "string", + "maxLength": 2048 } } }, "dto.ForgotPasswordRequest": { "type": "object", + "required": [ + "username_or_email" + ], "properties": { "username_or_email": { "type": "string" @@ -1849,12 +1862,20 @@ }, "dto.LoginRequest": { "type": "object", + "required": [ + "password", + "username" + ], "properties": { "password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, @@ -1872,31 +1893,51 @@ }, "dto.RegisterRequest": { "type": "object", + "required": [ + "email", + "password", + "username" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 }, "password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, "dto.ResendVerificationRequest": { "type": "object", + "required": [ + "email" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 } } }, "dto.ResetPasswordRequest": { "type": "object", + "required": [ + "new_password", + "token" + ], "properties": { "new_password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 }, "token": { "type": "string" @@ -1917,39 +1958,60 @@ }, "dto.UpdateEmailRequest": { "type": "object", + "required": [ + "email" + ], "properties": { "email": { - "type": "string" + "type": "string", + "maxLength": 254 } } }, "dto.UpdatePasswordRequest": { "type": "object", + "required": [ + "current_password", + "new_password" + ], "properties": { "current_password": { "type": "string" }, "new_password": { - "type": "string" + "type": "string", + "maxLength": 128, + "minLength": 8 } } }, "dto.UpdatePostRequest": { "type": "object", + "required": [ + "title" + ], "properties": { "content": { - "type": "string" + "type": "string", + "maxLength": 10000 }, "title": { - "type": "string" + "type": "string", + "maxLength": 200, + "minLength": 3 } } }, "dto.UpdateUsernameRequest": { "type": "object", + "required": [ + "username" + ], "properties": { "username": { - "type": "string" + "type": "string", + "maxLength": 50, + "minLength": 3 } } }, diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 4db1a64..841d6f0 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -6,27 +6,44 @@ definitions: type: boolean token: type: string + required: + - token type: object dto.CreatePostRequest: properties: content: + maxLength: 10000 type: string title: + maxLength: 200 + minLength: 3 type: string url: + maxLength: 2048 type: string + required: + - url type: object dto.ForgotPasswordRequest: properties: username_or_email: type: string + required: + - username_or_email type: object dto.LoginRequest: properties: password: + maxLength: 128 + minLength: 8 type: string username: + maxLength: 50 + minLength: 3 type: string + required: + - password + - username type: object dto.RefreshTokenRequest: properties: @@ -39,23 +56,40 @@ definitions: dto.RegisterRequest: properties: email: + maxLength: 254 type: string password: + maxLength: 128 + minLength: 8 type: string username: + maxLength: 50 + minLength: 3 type: string + required: + - email + - password + - username type: object dto.ResendVerificationRequest: properties: email: + maxLength: 254 type: string + required: + - email type: object dto.ResetPasswordRequest: properties: new_password: + maxLength: 128 + minLength: 8 type: string token: type: string + required: + - new_password + - token type: object dto.RevokeTokenRequest: properties: @@ -68,26 +102,43 @@ definitions: dto.UpdateEmailRequest: properties: email: + maxLength: 254 type: string + required: + - email type: object dto.UpdatePasswordRequest: properties: current_password: type: string new_password: + maxLength: 128 + minLength: 8 type: string + required: + - current_password + - new_password type: object dto.UpdatePostRequest: properties: content: + maxLength: 10000 type: string title: + maxLength: 200 + minLength: 3 type: string + required: + - title type: object dto.UpdateUsernameRequest: properties: username: + maxLength: 50 + minLength: 3 type: string + required: + - username type: object handlers.APIInfo: properties: