swagger docs update
This commit is contained in:
nquidox
parent
71d13bb217
commit
cfccb19666
3 changed files with 381 additions and 6 deletions
145
docs/docs.go
145
docs/docs.go
|
|
@ -61,6 +61,65 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
},
|
||||
"/merch/extra/{uuid}": {
|
||||
"put": {
|
||||
"description": "Update ONLY merch extra data",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Merch"
|
||||
],
|
||||
"summary": "Update merch extra data",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "merch uuid",
|
||||
"name": "uuid",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "payload",
|
||||
"name": "payload",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.extraDataDTO"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.extraDataDTO"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.BadRequest"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.Unauthorized"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.InternalServerError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/merch/list": {
|
||||
"get": {
|
||||
"description": "Get all merch without origins",
|
||||
|
|
@ -235,6 +294,63 @@ const docTemplate = `{
|
|||
}
|
||||
},
|
||||
"/merch/{uuid}": {
|
||||
"put": {
|
||||
"description": "Update merch general info (except extra data)",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Merch"
|
||||
],
|
||||
"summary": "Update merch",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "merch uuid",
|
||||
"name": "uuid",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "payload",
|
||||
"name": "payload",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.updateMerchDTO"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.merchDTO"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.BadRequest"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.Unauthorized"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.InternalServerError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"description": "Marks merch and all its extra data as deleted by uuid.",
|
||||
"consumes": [
|
||||
|
|
@ -288,6 +404,20 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
},
|
||||
"merch.extraDataDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"links": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/merch.originLink"
|
||||
}
|
||||
},
|
||||
"merch_uuid": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"merch.merchDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -341,10 +471,10 @@ const docTemplate = `{
|
|||
"merch.originLink": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"origin_link": {
|
||||
"origin": {
|
||||
"type": "string"
|
||||
},
|
||||
"origin_name": {
|
||||
"origin_link": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
|
|
@ -360,6 +490,17 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
},
|
||||
"merch.updateMerchDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"merch_uuid": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses.BadRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
|
|||
|
|
@ -54,6 +54,65 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/merch/extra/{uuid}": {
|
||||
"put": {
|
||||
"description": "Update ONLY merch extra data",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Merch"
|
||||
],
|
||||
"summary": "Update merch extra data",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "merch uuid",
|
||||
"name": "uuid",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "payload",
|
||||
"name": "payload",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.extraDataDTO"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.extraDataDTO"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.BadRequest"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.Unauthorized"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.InternalServerError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/merch/list": {
|
||||
"get": {
|
||||
"description": "Get all merch without origins",
|
||||
|
|
@ -228,6 +287,63 @@
|
|||
}
|
||||
},
|
||||
"/merch/{uuid}": {
|
||||
"put": {
|
||||
"description": "Update merch general info (except extra data)",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Merch"
|
||||
],
|
||||
"summary": "Update merch",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "merch uuid",
|
||||
"name": "uuid",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "payload",
|
||||
"name": "payload",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.updateMerchDTO"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/merch.merchDTO"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.BadRequest"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.Unauthorized"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/responses.InternalServerError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"description": "Marks merch and all its extra data as deleted by uuid.",
|
||||
"consumes": [
|
||||
|
|
@ -281,6 +397,20 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"merch.extraDataDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"links": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/merch.originLink"
|
||||
}
|
||||
},
|
||||
"merch_uuid": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"merch.merchDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -334,10 +464,10 @@
|
|||
"merch.originLink": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"origin_link": {
|
||||
"origin": {
|
||||
"type": "string"
|
||||
},
|
||||
"origin_name": {
|
||||
"origin_link": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
|
|
@ -353,6 +483,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"merch.updateMerchDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"merch_uuid": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses.BadRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@ definitions:
|
|||
name:
|
||||
type: string
|
||||
type: object
|
||||
merch.extraDataDTO:
|
||||
properties:
|
||||
links:
|
||||
items:
|
||||
$ref: '#/definitions/merch.originLink'
|
||||
type: array
|
||||
merch_uuid:
|
||||
type: string
|
||||
type: object
|
||||
merch.merchDTO:
|
||||
properties:
|
||||
created_at:
|
||||
|
|
@ -39,9 +48,9 @@ definitions:
|
|||
type: object
|
||||
merch.originLink:
|
||||
properties:
|
||||
origin_link:
|
||||
origin:
|
||||
type: string
|
||||
origin_name:
|
||||
origin_link:
|
||||
type: string
|
||||
type: object
|
||||
merch.originsDTO:
|
||||
|
|
@ -51,6 +60,13 @@ definitions:
|
|||
$ref: '#/definitions/merch.originItem'
|
||||
type: array
|
||||
type: object
|
||||
merch.updateMerchDTO:
|
||||
properties:
|
||||
merch_uuid:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
type: object
|
||||
responses.BadRequest:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -104,6 +120,44 @@ paths:
|
|||
summary: Delete merch
|
||||
tags:
|
||||
- Merch
|
||||
put:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Update merch general info (except extra data)
|
||||
parameters:
|
||||
- description: merch uuid
|
||||
in: path
|
||||
name: uuid
|
||||
required: true
|
||||
type: string
|
||||
- description: payload
|
||||
in: body
|
||||
name: payload
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/merch.updateMerchDTO'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/merch.merchDTO'
|
||||
"400":
|
||||
description: Bad Request
|
||||
schema:
|
||||
$ref: '#/definitions/responses.BadRequest'
|
||||
"401":
|
||||
description: Unauthorized
|
||||
schema:
|
||||
$ref: '#/definitions/responses.Unauthorized'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/responses.InternalServerError'
|
||||
summary: Update merch
|
||||
tags:
|
||||
- Merch
|
||||
/merch/create:
|
||||
post:
|
||||
consumes:
|
||||
|
|
@ -134,6 +188,45 @@ paths:
|
|||
summary: Create new merch
|
||||
tags:
|
||||
- Merch
|
||||
/merch/extra/{uuid}:
|
||||
put:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Update ONLY merch extra data
|
||||
parameters:
|
||||
- description: merch uuid
|
||||
in: path
|
||||
name: uuid
|
||||
required: true
|
||||
type: string
|
||||
- description: payload
|
||||
in: body
|
||||
name: payload
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/merch.extraDataDTO'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/merch.extraDataDTO'
|
||||
"400":
|
||||
description: Bad Request
|
||||
schema:
|
||||
$ref: '#/definitions/responses.BadRequest'
|
||||
"401":
|
||||
description: Unauthorized
|
||||
schema:
|
||||
$ref: '#/definitions/responses.Unauthorized'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/responses.InternalServerError'
|
||||
summary: Update merch extra data
|
||||
tags:
|
||||
- Merch
|
||||
/merch/list:
|
||||
get:
|
||||
description: Get all merch without origins
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue