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 1m29s
Details

Browse source
This commit is contained in:
nquidox 2025-10-18 14:11:58 +03:00
parent c2304f6a7d
commit f561869b08
4 changed files with 35 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/docs.go
View file

@ -169,7 +169,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/merch.PricesResponse"
"$ref": "#/definitions/merch.ImageLink"
}
},
"400": {
@ -267,21 +267,11 @@ const docTemplate = `{
"name": "uuid",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image type",
"name": "type",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/merch.PricesResponse"
}
"description": "OK"
},
"400": {
"description": "Bad Request",
@ -778,6 +768,17 @@ const docTemplate = `{
}
},
"definitions": {
"merch.ImageLink": {
"type": "object",
"properties": {
"etag": {
"type": "string"
},
"link": {
"type": "string"
}
}
},
"merch.ListResponse": {
"type": "object",
"properties": {

25
docs/swagger.json
View file

@ -161,7 +161,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/merch.PricesResponse"
"$ref": "#/definitions/merch.ImageLink"
}
},
"400": {
@ -259,21 +259,11 @@
"name": "uuid",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image type",
"name": "type",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/merch.PricesResponse"
}
"description": "OK"
},
"400": {
"description": "Bad Request",
@ -770,6 +760,17 @@
}
},
"definitions": {
"merch.ImageLink": {
"type": "object",
"properties": {
"etag": {
"type": "string"
},
"link": {
"type": "string"
}
}
},
"merch.ListResponse": {
"type": "object",
"properties": {

16
docs/swagger.yaml
View file

@ -1,5 +1,12 @@
basePath: /api/v2
definitions:
merch.ImageLink:
properties:
etag:
type: string
link:
type: string
type: object
merch.ListResponse:
properties:
merch_uuid:
@ -271,16 +278,9 @@ paths:
name: uuid
required: true
type: string
- description: image type
in: query
name: type
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/merch.PricesResponse'
"400":
description: Bad Request
schema:
@ -311,7 +311,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/merch.PricesResponse'
$ref: '#/definitions/merch.ImageLink'
"400":
description: Bad Request
schema:

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

@ -370,8 +370,7 @@ func (co *controller) getMerchImage(c *gin.Context) {
// @Tags Merch images
// @Security BearerAuth
// @Param uuid path string true "merch_uuid"
// @Param type query string true "image type"
// @Success 200 {object} PricesResponse
// @Success 200
// @Failure 400 {object} responses.ErrorResponse400
// @Failure 500 {object} responses.ErrorResponse500
// @Router /merch/images/{uuid} [delete]