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

swagger docs added

Browse source
This commit is contained in:
nquidox 2026-03-01 22:15:10 +03:00
parent 2d965d53ac
commit f962cd8cd9
5 changed files with 585 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

208
docs/swagger.json Normal file
View file

@ -0,0 +1,208 @@
{
"swagger": "2.0",
"info": {
"description": "Stores data about merch and prices",
"title": "Merch API",
"contact": {},
"version": "2.3"
},
"basePath": "/api/v2",
"paths": {
"/merch/origins": {
"get": {
"description": "Get all origins",
"produces": [
"application/json"
],
"tags": [
"Origins"
],
"summary": "Get all origins",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/merch.originsDTO"
}
},
"204": {
"description": "No Content"
},
"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"
}
}
}
},
"post": {
"description": "Create new origin with name",
"consumes": [
"application/json"
],
"tags": [
"Origins"
],
"summary": "Create new origin",
"parameters": [
{
"description": "origin body",
"name": "origin",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/merch.newOriginDTO"
}
}
],
"responses": {
"201": {
"description": "Created"
},
"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 origin as deleted by name.",
"consumes": [
"application/json"
],
"tags": [
"Origins"
],
"summary": "Delete origin",
"parameters": [
{
"description": "origin body",
"name": "origin",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/merch.deleteOriginDTO"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"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"
}
}
}
}
}
},
"definitions": {
"merch.deleteOriginDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"merch.newOriginDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"merch.originItem": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"merch.originsDTO": {
"type": "object",
"properties": {
"origins": {
"type": "array",
"items": {
"$ref": "#/definitions/merch.originItem"
}
}
}
},
"responses.BadRequest": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "error"
}
}
},
"responses.InternalServerError": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "error"
}
}
},
"responses.Unauthorized": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "error"
}
}
}
}
}