swagger docs update

This commit is contained in:
nquidox 2025-11-02 21:10:59 +03:00
parent 93ce93770d
commit a0e21db5a0
3 changed files with 472 additions and 0 deletions

View file

@ -68,6 +68,9 @@ const docTemplate = `{
}
],
"description": "Получить все записи мерча",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -145,6 +148,9 @@ const docTemplate = `{
}
],
"description": "Получить картинки по merch_uuid и query параметрам",
"produces": [
"application/json"
],
"tags": [
"Merch images"
],
@ -287,6 +293,9 @@ const docTemplate = `{
}
],
"description": "Получить все метки товаров",
"produces": [
"application/json"
],
"tags": [
"Merch labels"
],
@ -441,6 +450,47 @@ const docTemplate = `{
}
},
"/merch/labels/{uuid}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Получить метки товара по его uuid",
"produces": [
"application/json"
],
"tags": [
"Merch labels"
],
"summary": "Получить метки товара по его uuid",
"parameters": [
{
"type": "string",
"description": "label uuid",
"name": "uuid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
},
"put": {
"security": [
{
@ -527,6 +577,86 @@ const docTemplate = `{
}
}
},
"/merch/zeroprices": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Получить нулевые цены",
"produces": [
"application/json"
],
"tags": [
"Merch zero prices"
],
"summary": "Получить нулевые цены",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/merch.ZeroPrice"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "Пометить нулевые цены как удаленные",
"tags": [
"Merch zero prices"
],
"summary": "Пометить нулевые цены как удаленные",
"parameters": [
{
"description": "payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/merch.DeleteZeroPrices"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
}
},
"/merch/{uuid}": {
"get": {
"security": [
@ -535,6 +665,9 @@ const docTemplate = `{
}
],
"description": "Получить всю информацию про мерч по его uuid",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -619,6 +752,9 @@ const docTemplate = `{
}
],
"description": "Получить цены мерча за период",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -664,6 +800,9 @@ const docTemplate = `{
}
],
"description": "Получить перепады цен мерча за период по его merch_uuid",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -1018,6 +1157,17 @@ const docTemplate = `{
}
}
},
"merch.DeleteZeroPrices": {
"type": "object",
"properties": {
"merch_uuids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"merch.ImageLink": {
"type": "object",
"properties": {
@ -1074,6 +1224,12 @@ const docTemplate = `{
"merch.ListResponse": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"merch_uuid": {
"type": "string"
},
@ -1093,6 +1249,12 @@ const docTemplate = `{
"merch.MerchDTO": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"merch_uuid": {
"type": "string"
},
@ -1174,6 +1336,23 @@ const docTemplate = `{
}
}
},
"merch.ZeroPrice": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"merch_uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"origin": {
"type": "string"
}
}
},
"responses.ErrorResponse400": {
"type": "object",
"properties": {

View file

@ -60,6 +60,9 @@
}
],
"description": "Получить все записи мерча",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -137,6 +140,9 @@
}
],
"description": "Получить картинки по merch_uuid и query параметрам",
"produces": [
"application/json"
],
"tags": [
"Merch images"
],
@ -279,6 +285,9 @@
}
],
"description": "Получить все метки товаров",
"produces": [
"application/json"
],
"tags": [
"Merch labels"
],
@ -433,6 +442,47 @@
}
},
"/merch/labels/{uuid}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Получить метки товара по его uuid",
"produces": [
"application/json"
],
"tags": [
"Merch labels"
],
"summary": "Получить метки товара по его uuid",
"parameters": [
{
"type": "string",
"description": "label uuid",
"name": "uuid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
},
"put": {
"security": [
{
@ -519,6 +569,86 @@
}
}
},
"/merch/zeroprices": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Получить нулевые цены",
"produces": [
"application/json"
],
"tags": [
"Merch zero prices"
],
"summary": "Получить нулевые цены",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/merch.ZeroPrice"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "Пометить нулевые цены как удаленные",
"tags": [
"Merch zero prices"
],
"summary": "Пометить нулевые цены как удаленные",
"parameters": [
{
"description": "payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/merch.DeleteZeroPrices"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse400"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/responses.ErrorResponse500"
}
}
}
}
},
"/merch/{uuid}": {
"get": {
"security": [
@ -527,6 +657,9 @@
}
],
"description": "Получить всю информацию про мерч по его uuid",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -611,6 +744,9 @@
}
],
"description": "Получить цены мерча за период",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -656,6 +792,9 @@
}
],
"description": "Получить перепады цен мерча за период по его merch_uuid",
"produces": [
"application/json"
],
"tags": [
"Merch"
],
@ -1010,6 +1149,17 @@
}
}
},
"merch.DeleteZeroPrices": {
"type": "object",
"properties": {
"merch_uuids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"merch.ImageLink": {
"type": "object",
"properties": {
@ -1066,6 +1216,12 @@
"merch.ListResponse": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"merch_uuid": {
"type": "string"
},
@ -1085,6 +1241,12 @@
"merch.MerchDTO": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"merch_uuid": {
"type": "string"
},
@ -1166,6 +1328,23 @@
}
}
},
"merch.ZeroPrice": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"merch_uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"origin": {
"type": "string"
}
}
},
"responses.ErrorResponse400": {
"type": "object",
"properties": {

View file

@ -7,6 +7,13 @@ definitions:
thumbnail:
type: string
type: object
merch.DeleteZeroPrices:
properties:
merch_uuids:
items:
type: string
type: array
type: object
merch.ImageLink:
properties:
etag:
@ -43,6 +50,10 @@ definitions:
type: object
merch.ListResponse:
properties:
labels:
items:
type: string
type: array
merch_uuid:
type: string
name:
@ -55,6 +66,10 @@ definitions:
type: object
merch.MerchDTO:
properties:
labels:
items:
type: string
type: array
merch_uuid:
type: string
name:
@ -107,6 +122,17 @@ definitions:
origin:
type: string
type: object
merch.ZeroPrice:
properties:
created_at:
type: string
merch_uuid:
type: string
name:
type: string
origin:
type: string
type: object
responses.ErrorResponse400:
properties:
error:
@ -205,6 +231,8 @@ paths:
/merch/:
get:
description: Получить все записи мерча
produces:
- application/json
responses:
"200":
description: OK
@ -285,6 +313,8 @@ paths:
name: uuid
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
@ -341,6 +371,8 @@ paths:
name: type
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
@ -398,6 +430,8 @@ paths:
/merch/labels:
get:
description: Получить все метки товаров
produces:
- application/json
responses:
"200":
description: OK
@ -468,6 +502,32 @@ paths:
summary: Пометить метку как удаленную
tags:
- Merch labels
get:
description: Получить метки товара по его uuid
parameters:
- description: label uuid
in: path
name: uuid
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
"400":
description: Bad Request
schema:
$ref: '#/definitions/responses.ErrorResponse400'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/responses.ErrorResponse500'
security:
- BearerAuth: []
summary: Получить метки товара по его uuid
tags:
- Merch labels
put:
description: Изменить метку
parameters:
@ -550,6 +610,56 @@ paths:
summary: Удалить привязку метки к товару
tags:
- Merch labels
/merch/zeroprices:
delete:
description: Пометить нулевые цены как удаленные
parameters:
- description: payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/merch.DeleteZeroPrices'
responses:
"200":
description: OK
"400":
description: Bad Request
schema:
$ref: '#/definitions/responses.ErrorResponse400'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/responses.ErrorResponse500'
security:
- BearerAuth: []
summary: Пометить нулевые цены как удаленные
tags:
- Merch zero prices
get:
description: Получить нулевые цены
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/merch.ZeroPrice'
type: array
"400":
description: Bad Request
schema:
$ref: '#/definitions/responses.ErrorResponse400'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/responses.ErrorResponse500'
security:
- BearerAuth: []
summary: Получить нулевые цены
tags:
- Merch zero prices
/prices:
get:
description: Получить цены мерча за период
@ -558,6 +668,8 @@ paths:
in: query
name: days
type: string
produces:
- application/json
responses:
"200":
description: OK
@ -591,6 +703,8 @@ paths:
in: query
name: days
type: string
produces:
- application/json
responses:
"200":
description: OK