merch-tracker-v2/api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

swagger docs update
All checks were successful
/ Make image (push) Successful in 1m3s
Details

Browse source
This commit is contained in:
nquidox 2025-11-02 23:39:25 +03:00
parent 2728051fde
commit 7fa79d770a
4 changed files with 114 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/docs.go
View file

@ -106,6 +106,9 @@ const docTemplate = `{
} }
], ],
"description": "Обновить информацию про мерч по его uuid в json-е", "description": "Обновить информацию про мерч по его uuid в json-е",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch" "Merch"
], ],
@ -331,6 +334,9 @@ const docTemplate = `{
} }
], ],
"description": "Создать новую метку для товара", "description": "Создать новую метку для товара",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -373,6 +379,9 @@ const docTemplate = `{
} }
], ],
"description": "Прикрепить метку к товару", "description": "Прикрепить метку к товару",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -415,6 +424,9 @@ const docTemplate = `{
} }
], ],
"description": "Удалить привязку метки к товару", "description": "Удалить привязку метки к товару",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -498,6 +510,9 @@ const docTemplate = `{
} }
], ],
"description": "Изменить метку", "description": "Изменить метку",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -623,6 +638,9 @@ const docTemplate = `{
} }
], ],
"description": "Пометить нулевые цены как удаленные", "description": "Пометить нулевые цены как удаленные",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch zero prices" "Merch zero prices"
], ],
@ -1160,11 +1178,11 @@ const docTemplate = `{
"merch.DeleteZeroPrices": { "merch.DeleteZeroPrices": {
"type": "object", "type": "object",
"properties": { "properties": {
"merch_uuids": { "id": {
"type": "array", "type": "integer"
"items": { },
"type": "string" "merch_uuid": {
} "type": "string"
} }
} }
}, },
@ -1342,6 +1360,9 @@ const docTemplate = `{
"created_at": { "created_at": {
"type": "string" "type": "string"
}, },
"id": {
"type": "integer"
},
"merch_uuid": { "merch_uuid": {
"type": "string" "type": "string"
}, },

31
docs/swagger.json
View file

@ -98,6 +98,9 @@
} }
], ],
"description": "Обновить информацию про мерч по его uuid в json-е", "description": "Обновить информацию про мерч по его uuid в json-е",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch" "Merch"
], ],
@ -323,6 +326,9 @@
} }
], ],
"description": "Создать новую метку для товара", "description": "Создать новую метку для товара",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -365,6 +371,9 @@
} }
], ],
"description": "Прикрепить метку к товару", "description": "Прикрепить метку к товару",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -407,6 +416,9 @@
} }
], ],
"description": "Удалить привязку метки к товару", "description": "Удалить привязку метки к товару",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -490,6 +502,9 @@
} }
], ],
"description": "Изменить метку", "description": "Изменить метку",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch labels" "Merch labels"
], ],
@ -615,6 +630,9 @@
} }
], ],
"description": "Пометить нулевые цены как удаленные", "description": "Пометить нулевые цены как удаленные",
"consumes": [
"application/json"
],
"tags": [ "tags": [
"Merch zero prices" "Merch zero prices"
], ],
@ -1152,11 +1170,11 @@
"merch.DeleteZeroPrices": { "merch.DeleteZeroPrices": {
"type": "object", "type": "object",
"properties": { "properties": {
"merch_uuids": { "id": {
"type": "array", "type": "integer"
"items": { },
"type": "string" "merch_uuid": {
} "type": "string"
} }
} }
}, },
@ -1334,6 +1352,9 @@
"created_at": { "created_at": {
"type": "string" "type": "string"
}, },
"id": {
"type": "integer"
},
"merch_uuid": { "merch_uuid": {
"type": "string" "type": "string"
}, },

22
docs/swagger.yaml
View file

@ -9,10 +9,10 @@ definitions:
type: object type: object
merch.DeleteZeroPrices: merch.DeleteZeroPrices:
properties: properties:
merch_uuids: id:
items: type: integer
type: string merch_uuid:
type: array type: string
type: object type: object
merch.ImageLink: merch.ImageLink:
properties: properties:
@ -126,6 +126,8 @@ definitions:
properties: properties:
created_at: created_at:
type: string type: string
id:
type: integer
merch_uuid: merch_uuid:
type: string type: string
name: name:
@ -254,6 +256,8 @@ paths:
tags: tags:
- Merch - Merch
put: put:
consumes:
- application/json
description: Обновить информацию про мерч по его uuid в json-е description: Обновить информацию про мерч по его uuid в json-е
parameters: parameters:
- description: merch_uuid - description: merch_uuid
@ -453,6 +457,8 @@ paths:
tags: tags:
- Merch labels - Merch labels
post: post:
consumes:
- application/json
description: Создать новую метку для товара description: Создать новую метку для товара
parameters: parameters:
- description: payload - description: payload
@ -529,6 +535,8 @@ paths:
tags: tags:
- Merch labels - Merch labels
put: put:
consumes:
- application/json
description: Изменить метку description: Изменить метку
parameters: parameters:
- description: label uuid - description: label uuid
@ -560,6 +568,8 @@ paths:
- Merch labels - Merch labels
/merch/labels/attach: /merch/labels/attach:
post: post:
consumes:
- application/json
description: Прикрепить метку к товару description: Прикрепить метку к товару
parameters: parameters:
- description: payload - description: payload
@ -586,6 +596,8 @@ paths:
- Merch labels - Merch labels
/merch/labels/detach: /merch/labels/detach:
post: post:
consumes:
- application/json
description: Удалить привязку метки к товару description: Удалить привязку метки к товару
parameters: parameters:
- description: payload - description: payload
@ -612,6 +624,8 @@ paths:
- Merch labels - Merch labels
/merch/zeroprices: /merch/zeroprices:
delete: delete:
consumes:
- application/json
description: Пометить нулевые цены как удаленные description: Пометить нулевые цены как удаленные
parameters: parameters:
- description: payload - description: payload

84
internal/api/merch/controller.go
View file

@ -95,7 +95,7 @@ func (co *controller) addMerch(c *gin.Context) {
// @Description Получить всю информацию про мерч по его uuid // @Description Получить всю информацию про мерч по его uuid
// @Tags Merch // @Tags Merch
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Param uuid path string true "merch_uuid" // @Param uuid path string true "merch_uuid"
// @Success 200 {object} MerchDTO // @Success 200 {object} MerchDTO
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
@ -129,7 +129,7 @@ func (co *controller) getSingleMerch(c *gin.Context) {
// @Description Получить все записи мерча // @Description Получить все записи мерча
// @Tags Merch // @Tags Merch
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Success 200 {array} ListResponse // @Success 200 {array} ListResponse
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
@ -156,7 +156,7 @@ func (co *controller) getAllMerch(c *gin.Context) {
// @Description Обновить информацию про мерч по его uuid в json-е // @Description Обновить информацию про мерч по его uuid в json-е
// @Tags Merch // @Tags Merch
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param body body UpdateMerchDTO true "merch_uuid" // @Param body body UpdateMerchDTO true "merch_uuid"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
@ -182,6 +182,7 @@ func (co *controller) updateMerch(c *gin.Context) {
log.WithError(err).Error("Merch | Failed to get single merch") log.WithError(err).Error("Merch | Failed to get single merch")
return return
} }
c.Status(http.StatusOK)
} }
// @Summary Пометить мерч как удаленный // @Summary Пометить мерч как удаленный
@ -192,7 +193,8 @@ func (co *controller) updateMerch(c *gin.Context) {
// @Success 200 {object} MerchDTO // @Success 200 {object} MerchDTO
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/{uuid} [delete] //
// @Router /merch/{uuid} [delete]
func (co *controller) deleteMerch(c *gin.Context) { func (co *controller) deleteMerch(c *gin.Context) {
merchUuid := c.Param("uuid") merchUuid := c.Param("uuid")
if merchUuid == "" { if merchUuid == "" {
@ -220,12 +222,16 @@ func (co *controller) deleteMerch(c *gin.Context) {
// @Description Получить цены мерча за период // @Description Получить цены мерча за период
// @Tags Merch // @Tags Merch
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Param days query string false "period in days" // @Param days query string false "period in days"
// @Success 200 {array} PricesResponse // @Success 200 {array} PricesResponse
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /prices [get] // @Router /prices [get]
//
// @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500
// @Router /prices [get]
func (co *controller) getChartsPrices(c *gin.Context) { func (co *controller) getChartsPrices(c *gin.Context) {
daysQuery := strings.ToLower(c.DefaultQuery("days", "")) daysQuery := strings.ToLower(c.DefaultQuery("days", ""))
@ -250,7 +256,7 @@ func (co *controller) getChartsPrices(c *gin.Context) {
// @Description Получить перепады цен мерча за период по его merch_uuid // @Description Получить перепады цен мерча за период по его merch_uuid
// @Tags Merch // @Tags Merch
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Param uuid path string true "merch_uuid" // @Param uuid path string true "merch_uuid"
// @Param days query string false "period in days" // @Param days query string false "period in days"
// @Success 200 {object} PricesResponse // @Success 200 {object} PricesResponse
@ -338,7 +344,6 @@ func (co *controller) uploadMerchImage(c *gin.Context) {
return return
} }
//c.Status(http.StatusOK)
c.JSON(http.StatusOK, response) c.JSON(http.StatusOK, response)
} }
@ -346,7 +351,7 @@ func (co *controller) uploadMerchImage(c *gin.Context) {
// @Description Получить картинки по merch_uuid и query параметрам // @Description Получить картинки по merch_uuid и query параметрам
// @Tags Merch images // @Tags Merch images
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Param uuid path string true "merch_uuid" // @Param uuid path string true "merch_uuid"
// @Param type query string true "image type" // @Param type query string true "image type"
// @Success 200 {object} ImageLink // @Success 200 {object} ImageLink
@ -393,7 +398,6 @@ func (co *controller) getMerchImage(c *gin.Context) {
//} //}
// //
//c.JSON(http.StatusOK, link) //c.JSON(http.StatusOK, link)
c.JSON(http.StatusNotImplemented, gin.H{"msg": "Method deprecated. Request images from image storage."})
} }
// @Summary Удалить (безвозвратно) картинки по merch_uuid // @Summary Удалить (безвозвратно) картинки по merch_uuid
@ -438,7 +442,7 @@ func (co *controller) deleteMerchImage(c *gin.Context) {
// @Description Создать новую метку для товара // @Description Создать новую метку для товара
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param payload body LabelDTO true "payload" // @Param payload body LabelDTO true "payload"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
@ -474,7 +478,7 @@ func (co *controller) createLabel(c *gin.Context) {
// @Description Получить все метки товаров // @Description Получить все метки товаров
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Success 200 {array} LabelsList // @Success 200 {array} LabelsList
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
@ -503,7 +507,7 @@ func (co *controller) getLabels(c *gin.Context) {
// @Description Изменить метку // @Description Изменить метку
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param uuid path string true "label uuid" // @Param uuid path string true "label uuid"
// @Param payload body LabelDTO true "payload" // @Param payload body LabelDTO true "payload"
// @Success 200 // @Success 200
@ -576,16 +580,16 @@ func (co *controller) deleteLabel(c *gin.Context) {
c.Status(http.StatusOK) c.Status(http.StatusOK)
} }
// @Summary Прикрепить метку к товару // @Summary Прикрепить метку к товару
// @Description Прикрепить метку к товару // @Description Прикрепить метку к товару
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param payload body LabelLink true "payload" // @Param payload body LabelLink true "payload"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/labels/attach [post] // @Router /merch/labels/attach [post]
func (co *controller) attachLabel(c *gin.Context) { func (co *controller) attachLabel(c *gin.Context) {
const logMsg = "Merch | Attach label" const logMsg = "Merch | Attach label"
@ -611,16 +615,16 @@ func (co *controller) attachLabel(c *gin.Context) {
c.Status(http.StatusOK) c.Status(http.StatusOK)
} }
// @Summary Удалить привязку метки к товару // @Summary Удалить привязку метки к товару
// @Description Удалить привязку метки к товару // @Description Удалить привязку метки к товару
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param payload body LabelLink true "payload" // @Param payload body LabelLink true "payload"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/labels/detach [post] // @Router /merch/labels/detach [post]
func (co *controller) detachLabel(c *gin.Context) { func (co *controller) detachLabel(c *gin.Context) {
const logMsg = "Merch | Detach label" const logMsg = "Merch | Detach label"
@ -650,7 +654,7 @@ func (co *controller) detachLabel(c *gin.Context) {
// @Description Получить метки товара по его uuid // @Description Получить метки товара по его uuid
// @Tags Merch labels // @Tags Merch labels
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Param uuid path string true "label uuid" // @Param uuid path string true "label uuid"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
@ -686,10 +690,10 @@ func (co *controller) getMerchLabels(c *gin.Context) {
// @Description Получить нулевые цены // @Description Получить нулевые цены
// @Tags Merch zero prices // @Tags Merch zero prices
// @Security BearerAuth // @Security BearerAuth
// @Produce json // @Produce json
// @Success 200 {array} ZeroPrice // @Success 200 {array} ZeroPrice
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/zeroprices [get] // @Router /merch/zeroprices [get]
func (co *controller) getZeroPrices(c *gin.Context) { func (co *controller) getZeroPrices(c *gin.Context) {
const logMsg = "Merch | Get zero prices" const logMsg = "Merch | Get zero prices"
@ -715,11 +719,11 @@ func (co *controller) getZeroPrices(c *gin.Context) {
// @Description Пометить нулевые цены как удаленные // @Description Пометить нулевые цены как удаленные
// @Tags Merch zero prices // @Tags Merch zero prices
// @Security BearerAuth // @Security BearerAuth
// Accept json // @Accept json
// @Param payload body DeleteZeroPrices true "payload" // @Param payload body DeleteZeroPrices true "payload"
// @Success 200 // @Success 200
// @Failure 400 {object} responses.ErrorResponse400 // @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500 // @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/zeroprices [delete] // @Router /merch/zeroprices [delete]
func (co *controller) deleteZeroPrices(c *gin.Context) { func (co *controller) deleteZeroPrices(c *gin.Context) {
const logMsg = "Merch | Delete zero prices" const logMsg = "Merch | Delete zero prices"