donatehelper/donat-widget
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs annottions

Browse Source
This commit is contained in:
harold 2025-03-08 22:21:10 +05:00
parent bccd1259b5
commit bd2843ff4e
5 changed files with 96 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
internal/docs/docs.go
View File

@ -1002,19 +1002,24 @@ const docTemplate = `{
"type": "object",
"properties": {
"file_id": {
"type": "string"
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"file_link": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/550e8400-e29b-41d4-a716-446655440000"
},
"file_name": {
"type": "string"
"type": "string",
"example": "header.png"
},
"file_size": {
"type": "integer"
"type": "integer",
"example": 1024
},
"file_type": {
"type": "string"
"type": "string",
"example": "image/png"
}
}
},
@ -1033,22 +1038,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"avatar_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/avatar.png"
},
"background_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/background.png"
},
"description": {
"type": "string"
"type": "string",
"example": "Поддержи этого стримера"
},
"head_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/header.png"
},
"login": {
"type": "string"
"type": "string",
"example": "streamer123"
},
"online": {
"type": "string"
"type": "string",
"example": "online"
}
}
},

33
internal/docs/swagger.json
View File

@ -995,19 +995,24 @@
"type": "object",
"properties": {
"file_id": {
"type": "string"
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"file_link": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/550e8400-e29b-41d4-a716-446655440000"
},
"file_name": {
"type": "string"
"type": "string",
"example": "header.png"
},
"file_size": {
"type": "integer"
"type": "integer",
"example": 1024
},
"file_type": {
"type": "string"
"type": "string",
"example": "image/png"
}
}
},
@ -1026,22 +1031,28 @@
"type": "object",
"properties": {
"avatar_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/avatar.png"
},
"background_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/background.png"
},
"description": {
"type": "string"
"type": "string",
"example": "Поддержи этого стримера"
},
"head_img": {
"type": "string"
"type": "string",
"example": "https://cdn.example.com/images/header.png"
},
"login": {
"type": "string"
"type": "string",
"example": "streamer123"
},
"online": {
"type": "string"
"type": "string",
"example": "online"
}
}
},

11
internal/docs/swagger.yaml
View File

@ -150,14 +150,19 @@ definitions:
donat-widget_internal_model.InnerFile:
properties:
file_id:
example: 550e8400-e29b-41d4-a716-446655440000
type: string
file_link:
example: https://cdn.example.com/images/550e8400-e29b-41d4-a716-446655440000
type: string
file_name:
example: header.png
type: string
file_size:
example: 1024
type: integer
file_type:
example: image/png
type: string
type: object
donat-widget_internal_model.ModerationResponse:
@ -170,16 +175,22 @@ definitions:
donat-widget_internal_model.OuterDonatePageResponse:
properties:
avatar_img:
example: https://cdn.example.com/images/avatar.png
type: string
background_img:
example: https://cdn.example.com/images/background.png
type: string
description:
example: Поддержи этого стримера
type: string
head_img:
example: https://cdn.example.com/images/header.png
type: string
login:
example: streamer123
type: string
online:
example: online
type: string
type: object
donat-widget_internal_model.UpdateFilterSettings:

22
internal/model/models.go
View File

@ -118,11 +118,11 @@ type DonatePage struct {
}
type InnerFile struct {
FileID uuid.UUID `json:"file_id"`
FileName string `json:"file_name"`
FileType string `json:"file_type"`
FileLink string `json:"file_link"`
FileSize int `json:"file_size"`
FileID uuid.UUID `json:"file_id" example:"550e8400-e29b-41d4-a716-446655440000" description:"UUID файла"`
FileName string `json:"file_name" example:"header.png" description:"Имя файла"`
FileType string `json:"file_type" example:"image/png" description:"Тип файла"`
FileLink string `json:"file_link" example:"https://cdn.example.com/images/550e8400-e29b-41d4-a716-446655440000" description:"Публичный URL файла"`
FileSize int `json:"file_size" example:"1024" description:"Размер файла в байтах"`
}
type InnerDonatePageResponse struct {
@ -141,12 +141,12 @@ type Moderation struct {
}
type OuterDonatePageResponse struct {
Login string `json:"login"`
OnLine string `json:"online"`
Description string `json:"description"`
BackgroundImg string `json:"background_img"`
AvatarImg string `json:"avatar_img"`
HeadImg string `json:"head_img"`
Login string `json:"login" example:"streamer123" description:"Логин или псевдоним стримера"`
OnLine string `json:"online" example:"online" description:"Статус стримера (online/offline)"`
Description string `json:"description" example:"Поддержи этого стримера" description:"Описание страницы доната"`
BackgroundImg string `json:"background_img" example:"https://cdn.example.com/images/background.png" description:"Ссылка на фоновое изображение"`
AvatarImg string `json:"avatar_img" example:"https://cdn.example.com/images/avatar.png" description:"Ссылка на аватар"`
HeadImg string `json:"head_img" example:"https://cdn.example.com/images/header.png" description:"Ссылка на хед-изображение"`
}
type Filter struct {

31
internal/model/sql/query.go
View File

@ -117,7 +117,36 @@ WHERE dp.streamer_id = (@streamer_id);
`
var GetDonationPageByLogin = `
SELECT * FROM donate_pages WHERE streamer_login = (@streamer_login);
SELECT
dp.id,
dp.streamer_id,
dp.description,
dp.text_after_donat,
dp.streamer_login,
-- Поля для хед-изображения
head_img.id AS head_img_id,
head_img.file_name AS head_img_file_name,
head_img.file_type AS head_img_type,
head_img.size AS head_img_size,
-- Поля для аватара
avatar.id AS avatar_id,
avatar.file_name AS avatar_file_name,
avatar.file_type AS avatar_type,
avatar.size AS avatar_img_size,
-- Поля для фона
background_img.id AS background_img_id,
background_img.file_name AS background_img_file_name,
background_img.file_type AS background_img_type,
background_img.size AS background_img_size
FROM donate_pages dp
LEFT JOIN files head_img ON dp.head_img = head_img.id
LEFT JOIN files avatar ON dp.avatar = avatar.id
LEFT JOIN files background_img ON dp.background_img = background_img.id
WHERE dp.streamer_login = (@streamer_login);
`
var GetWidgetsByStreamerID = `