Mirrors/VILLASweb-backend-go
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/web-backend-go/ synced 2025-03-30 00:00:12 +01:00
Code Issues Releases Wiki Activity

Update API doc

Browse source
This commit is contained in:
Sonja Happ 2021-01-12 17:06:02 +01:00
parent 1d1b3388a3
commit 88970d79a7
3 changed files with 31 additions and 198 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
doc/api/docs.go
View file

@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2020-11-19 17:20:42.626650342 +0100 CET m=+0.093632886
// 2021-01-12 17:04:27.751319166 +0100 CET m=+0.123714746
package docs
@ -806,6 +806,15 @@ var doc = `{
],
"produces": [
"text/plain",
"text/csv",
"application/gzip",
"application/x-gtar",
"application/x-tar",
"application/x-ustar",
"application/zip",
"application/msexcel",
"application/xml",
"application/x-bag",
"image/png",
"image/jpeg",
"image/gif",
@ -1691,7 +1700,7 @@ var doc = `{
"tags": [
"results"
],
"summary": "Delete a Result",
"summary": "Delete a Result incl. all result files",
"operationId": "deleteResult",
"parameters": [
{
@ -1814,78 +1823,6 @@ var doc = `{
}
},
"/results/{resultID}/file/{fileID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"produces": [
"text/plain",
"text/csv",
"application/gzip",
"application/x-gtar",
"application/x-tar",
"application/x-ustar",
"application/zip",
"application/msexcel",
"application/xml",
"application/x-bag"
],
"tags": [
"results"
],
"summary": "Download a result file",
"operationId": "getResultFile",
"parameters": [
{
"type": "integer",
"description": "Result ID",
"name": "resultID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ID of the file to download",
"name": "fileID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "File that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseFile"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"422": {
"description": "Unprocessable entity",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
}
}
},
"delete": {
"security": [
{

83
doc/api/swagger.json
View file

@ -789,6 +789,15 @@
],
"produces": [
"text/plain",
"text/csv",
"application/gzip",
"application/x-gtar",
"application/x-tar",
"application/x-ustar",
"application/zip",
"application/msexcel",
"application/xml",
"application/x-bag",
"image/png",
"image/jpeg",
"image/gif",
@ -1674,7 +1683,7 @@
"tags": [
"results"
],
"summary": "Delete a Result",
"summary": "Delete a Result incl. all result files",
"operationId": "deleteResult",
"parameters": [
{
@ -1797,78 +1806,6 @@
}
},
"/results/{resultID}/file/{fileID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"produces": [
"text/plain",
"text/csv",
"application/gzip",
"application/x-gtar",
"application/x-tar",
"application/x-ustar",
"application/zip",
"application/msexcel",
"application/xml",
"application/x-bag"
],
"tags": [
"results"
],
"summary": "Download a result file",
"operationId": "getResultFile",
"parameters": [
{
"type": "integer",
"description": "Result ID",
"name": "resultID",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ID of the file to download",
"name": "fileID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "File that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseFile"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"422": {
"description": "Unprocessable entity",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
}
}
},
"delete": {
"security": [
{

61
doc/api/swagger.yaml
View file

@ -1355,6 +1355,15 @@ paths:
type: integer
produces:
- text/plain
- text/csv
- application/gzip
- application/x-gtar
- application/x-tar
- application/x-ustar
- application/zip
- application/msexcel
- application/xml
- application/x-bag
- image/png
- image/jpeg
- image/gif
@ -1834,7 +1843,7 @@ paths:
$ref: '#/definitions/docs.ResponseError'
security:
- Bearer: []
summary: Delete a Result
summary: Delete a Result incl. all result files
tags:
- results
get:
@ -2013,56 +2022,6 @@ paths:
summary: Delete a result file
tags:
- results
get:
operationId: getResultFile
parameters:
- description: Result ID
in: path
name: resultID
required: true
type: integer
- description: ID of the file to download
in: path
name: fileID
required: true
type: integer
produces:
- text/plain
- text/csv
- application/gzip
- application/x-gtar
- application/x-tar
- application/x-ustar
- application/zip
- application/msexcel
- application/xml
- application/x-bag
responses:
"200":
description: File that was requested
schema:
$ref: '#/definitions/docs.ResponseFile'
"400":
description: Bad request
schema:
$ref: '#/definitions/docs.ResponseError'
"404":
description: Not found
schema:
$ref: '#/definitions/docs.ResponseError'
"422":
description: Unprocessable entity
schema:
$ref: '#/definitions/docs.ResponseError'
"500":
description: Internal server error
schema:
$ref: '#/definitions/docs.ResponseError'
security:
- Bearer: []
summary: Download a result file
tags:
- results
/scenarios:
get:
operationId: getScenarios