mirror of
https://git.rwth-aachen.de/acs/public/villas/web-backend-go/
synced 2025-03-30 00:00:12 +01:00
Update API doc
This commit is contained in:
Sonja Happ
parent
1d1b3388a3
commit
88970d79a7
3 changed files with 31 additions and 198 deletions
|
|
@ -1,6 +1,6 @@
|
||||||
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
||||||
// This file was generated by swaggo/swag at
|
// 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
|
package docs
|
||||||
|
|
||||||
|
|
@ -806,6 +806,15 @@ var doc = `{
|
||||||
],
|
],
|
||||||
"produces": [
|
"produces": [
|
||||||
"text/plain",
|
"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/png",
|
||||||
"image/jpeg",
|
"image/jpeg",
|
||||||
"image/gif",
|
"image/gif",
|
||||||
|
|
@ -1691,7 +1700,7 @@ var doc = `{
|
||||||
"tags": [
|
"tags": [
|
||||||
"results"
|
"results"
|
||||||
],
|
],
|
||||||
"summary": "Delete a Result",
|
"summary": "Delete a Result incl. all result files",
|
||||||
"operationId": "deleteResult",
|
"operationId": "deleteResult",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
|
|
@ -1814,78 +1823,6 @@ var doc = `{
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/results/{resultID}/file/{fileID}": {
|
"/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": {
|
"delete": {
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -789,6 +789,15 @@
|
||||||
],
|
],
|
||||||
"produces": [
|
"produces": [
|
||||||
"text/plain",
|
"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/png",
|
||||||
"image/jpeg",
|
"image/jpeg",
|
||||||
"image/gif",
|
"image/gif",
|
||||||
|
|
@ -1674,7 +1683,7 @@
|
||||||
"tags": [
|
"tags": [
|
||||||
"results"
|
"results"
|
||||||
],
|
],
|
||||||
"summary": "Delete a Result",
|
"summary": "Delete a Result incl. all result files",
|
||||||
"operationId": "deleteResult",
|
"operationId": "deleteResult",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
|
|
@ -1797,78 +1806,6 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/results/{resultID}/file/{fileID}": {
|
"/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": {
|
"delete": {
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -1355,6 +1355,15 @@ paths:
|
||||||
type: integer
|
type: integer
|
||||||
produces:
|
produces:
|
||||||
- text/plain
|
- 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/png
|
||||||
- image/jpeg
|
- image/jpeg
|
||||||
- image/gif
|
- image/gif
|
||||||
|
|
@ -1834,7 +1843,7 @@ paths:
|
||||||
$ref: '#/definitions/docs.ResponseError'
|
$ref: '#/definitions/docs.ResponseError'
|
||||||
security:
|
security:
|
||||||
- Bearer: []
|
- Bearer: []
|
||||||
summary: Delete a Result
|
summary: Delete a Result incl. all result files
|
||||||
tags:
|
tags:
|
||||||
- results
|
- results
|
||||||
get:
|
get:
|
||||||
|
|
@ -2013,56 +2022,6 @@ paths:
|
||||||
summary: Delete a result file
|
summary: Delete a result file
|
||||||
tags:
|
tags:
|
||||||
- results
|
- 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:
|
/scenarios:
|
||||||
get:
|
get:
|
||||||
operationId: getScenarios
|
operationId: getScenarios
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue