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
VILLASweb-backend-go/doc/api/docs.go

3816 lines
132 KiB
Go
Raw Blame History

// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-11-13 20:52:36.885507 +0100 CET m=+0.101033324
package docs
import (
"bytes"
"encoding/json"
"strings"
"github.com/alecthomas/template"
"github.com/swaggo/swag"
)
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{.Description}}",
"title": "{{.Title}}",
"contact": {
"name": "Sonja Happ",
"email": "sonja.happ@eonerc.rwth-aachen.de"
},
"license": {
"name": "GNU GPL 3.0",
"url": "http://www.gnu.de/documents/gpl-3.0.en.html"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/authenticate": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"authentication"
],
"summary": "Authentication for user",
"operationId": "authenticate",
"parameters": [
{
"description": "loginRequest of user",
"name": "inputUser",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.loginRequest"
}
}
],
"responses": {
"200": {
"description": "JSON web token, success status, message and authenticated user object",
"schema": {
"$ref": "#/definitions/docs.ResponseAuthenticate"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
}
}
}
},
"/dashboards": {
"get": {
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get all dashboards of scenario",
"operationId": "getDashboards",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Dashboards which belong to scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseDashboards"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Add a dashboard to a scenario",
"operationId": "addDashboard",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Dashboard to be added incl. ID of Scenario",
"name": "inputDab",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dashboard.addDashboardRequest"
}
}
],
"responses": {
"200": {
"description": "Dashboard that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseDashboard"
}
},
"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"
}
}
}
}
},
"/dashboards/{dashboardID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get a dashboard",
"operationId": "getDashboard",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Dashboard ID",
"name": "dashboardID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Dashboard that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseDashboard"
}
},
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Update a dashboard",
"operationId": "updateDashboard",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Dashboard to be updated",
"name": "inputDab",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dashboard.updateDashboardRequest"
}
},
{
"type": "integer",
"description": "Dashboard ID",
"name": "dashboardID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Dashboard that was updated",
"schema": {
"$ref": "#/definitions/docs.ResponseDashboard"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Delete a dashboard",
"operationId": "deleteDashboard",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Dashboard ID",
"name": "dashboardID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Dashboard that was deleted",
"schema": {
"$ref": "#/definitions/docs.ResponseDashboard"
}
},
"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"
}
}
}
}
},
"/files": {
"get": {
"produces": [
"application/json"
],
"tags": [
"files"
],
"summary": "Get all files of a specific model or widget",
"operationId": "getFiles",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "Set to model for files of model, set to widget for files of widget",
"name": "objectType",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "ID of either model or widget of which files are requested",
"name": "objectID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Files which belong to simulation model or widget",
"schema": {
"$ref": "#/definitions/docs.ResponseFiles"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"text/plain",
"image/png",
"image/jpeg",
"image/gif",
"model/x-cim",
"model/x-cim.zip"
],
"produces": [
"application/json"
],
"tags": [
"files"
],
"summary": "Add a file to a specific model or widget",
"operationId": "addFile",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "file",
"description": "File to be uploaded",
"name": "inputFile",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "Set to model for files of model, set to widget for files of widget",
"name": "objectType",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "ID of either model or widget of which files are requested",
"name": "objectID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "File that was added",
"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"
}
}
}
}
},
"/files/{fileID}": {
"get": {
"produces": [
"text/plain",
"image/png",
"image/jpeg",
"image/gif",
"model/x-cim",
"model/x-cim.zip"
],
"tags": [
"files"
],
"summary": "Download a file",
"operationId": "getFile",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"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"
}
}
}
},
"put": {
"consumes": [
"text/plain",
"image/png",
"image/jpeg",
"image/gif",
"model/x-cim",
"model/x-cim.zip"
],
"produces": [
"application/json"
],
"tags": [
"files"
],
"summary": "Update a file",
"operationId": "updateFile",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "file",
"description": "File to be uploaded",
"name": "inputFile",
"in": "formData",
"required": true
},
{
"type": "integer",
"description": "ID of the file to update",
"name": "fileID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "File that was updated",
"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": {
"produces": [
"application/json"
],
"tags": [
"files"
],
"summary": "Delete a file",
"operationId": "deleteFile",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "ID of the file to update",
"name": "fileID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "File that was deleted",
"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"
}
}
}
}
},
"/healthz": {
"get": {
"produces": [
"application/json"
],
"tags": [
"healthz"
],
"summary": "Get health status of backend",
"operationId": "getHealth",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Backend is healthy, database and AMQP broker connections are alive"
},
"500": {
"description": "Backend is NOT healthy",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
}
}
}
},
"/models": {
"get": {
"produces": [
"application/json"
],
"tags": [
"models"
],
"summary": "Get all simulation models of scenario",
"operationId": "getSimulationModels",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Simulation models which belong to scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModels"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"models"
],
"summary": "Add a simulation model to a scenario",
"operationId": "addSimulationModel",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Simulation model to be added incl. IDs of scenario and simulator",
"name": "inputSimulationModel",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/simulationmodel.addSimulationModelRequest"
}
}
],
"responses": {
"200": {
"description": "simulation model that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModel"
}
},
"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"
}
}
}
}
},
"/models/{modelID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"models"
],
"summary": "Get a simulation model",
"operationId": "getSimulationModel",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Model ID",
"name": "modelID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "simulation model that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModel"
}
},
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"models"
],
"summary": "Update a simulation model",
"operationId": "updateSimulationModel",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Simulation model to be updated",
"name": "inputSimulationModel",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/simulationmodel.updateSimulationModelRequest"
}
},
{
"type": "integer",
"description": "Model ID",
"name": "modelID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "simulation model that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModel"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"models"
],
"summary": "Delete a simulation model",
"operationId": "deleteSimulationModel",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Model ID",
"name": "modelID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "simulation model that was deleted",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModel"
}
},
"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"
}
}
}
}
},
"/scenarios": {
"get": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Get all scenarios of requesting user",
"operationId": "getScenarios",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Scenarios to which user has access",
"schema": {
"$ref": "#/definitions/docs.ResponseScenarios"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Add a scenario",
"operationId": "addScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Scenario to be added",
"name": "inputScenario",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/scenario.addScenarioRequest"
}
}
],
"responses": {
"200": {
"description": "scenario that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseScenario"
}
},
"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"
}
}
}
}
},
"/scenarios/{scenarioID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Get scenario",
"operationId": "getScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Scenario requested by user",
"schema": {
"$ref": "#/definitions/docs.ResponseScenario"
}
},
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Update a scenario",
"operationId": "updateScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Scenario to be updated",
"name": "inputScenario",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/scenario.updateScenarioRequest"
}
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Updated scenario.",
"schema": {
"$ref": "#/definitions/docs.ResponseScenario"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Delete a scenario",
"operationId": "deleteScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Deleted scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseScenario"
}
},
"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"
}
}
}
}
},
"/scenarios/{scenarioID}/user": {
"put": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Add a user to a a scenario",
"operationId": "addUserToScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User name",
"name": "username",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "User that was added to scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Delete a user from a scenario",
"operationId": "deleteUserFromScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User name",
"name": "username",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "User that was deleted from scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"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"
}
}
}
}
},
"/scenarios/{scenarioID}/users/": {
"get": {
"produces": [
"application/json"
],
"tags": [
"scenarios"
],
"summary": "Get users of a scenario",
"operationId": "getUsersOfScenario",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Scenario ID",
"name": "scenarioID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Array of users that have access to the scenario",
"schema": {
"$ref": "#/definitions/docs.ResponseUsers"
}
},
"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"
}
}
}
}
},
"/signals": {
"get": {
"produces": [
"application/json"
],
"tags": [
"signals"
],
"summary": "Get all signals of one direction",
"operationId": "getSignals",
"parameters": [
{
"type": "string",
"description": "Direction of signal (in or out)",
"name": "direction",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Model ID of signals to be obtained",
"name": "modelID",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Signals which belong to simulation model",
"schema": {
"$ref": "#/definitions/docs.ResponseSignals"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"signals"
],
"summary": "Add a signal to a signal mapping of a model",
"operationId": "AddSignal",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "A signal to be added to the model incl. direction and model ID to which signal shall be added",
"name": "inputSignal",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/signal.addSignalRequest"
}
}
],
"responses": {
"200": {
"description": "Signal that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseSignal"
}
},
"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"
}
}
}
}
},
"/signals/{signalID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"signals"
],
"summary": "Get a signal",
"operationId": "getSignal",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "ID of signal to be obtained",
"name": "signalID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Signal that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseSignal"
}
},
"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"
}
}
}
},
"put": {
"produces": [
"application/json"
],
"tags": [
"signals"
],
"summary": "Update a signal",
"operationId": "updateSignal",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "A signal to be updated",
"name": "inputSignal",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/signal.updateSignalRequest"
}
},
{
"type": "integer",
"description": "ID of signal to be updated",
"name": "signalID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Signal that was updated",
"schema": {
"$ref": "#/definitions/docs.ResponseSignal"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"signals"
],
"summary": "Delete a signal",
"operationId": "deleteSignal",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "ID of signal to be deleted",
"name": "signalID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Signal that was deleted",
"schema": {
"$ref": "#/definitions/docs.ResponseSignal"
}
},
"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"
}
}
}
}
},
"/simulators": {
"get": {
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Get all simulators",
"operationId": "getSimulators",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Simulators requested",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulators"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Add a simulator",
"operationId": "addSimulator",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Simulator to be added",
"name": "inputSimulator",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/simulator.addSimulatorRequest"
}
}
],
"responses": {
"200": {
"description": "Simulator that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulator"
}
},
"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"
}
}
}
}
},
"/simulators/{simulatorID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Get simulator",
"operationId": "getSimulator",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Simulator ID",
"name": "simulatorID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Simulator that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulator"
}
},
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Update a simulator",
"operationId": "updateSimulator",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Simulator to be updated",
"name": "inputSimulator",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/simulator.updateSimulatorRequest"
}
},
{
"type": "integer",
"description": "Simulator ID",
"name": "simulatorID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Simulator that was updated",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulator"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Delete a simulator",
"operationId": "deleteSimulator",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Simulator ID",
"name": "simulatorID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Simulator that was deleted",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulator"
}
},
"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"
}
}
}
}
},
"/simulators/{simulatorID}/action": {
"post": {
"produces": [
"application/json"
],
"tags": [
"AMQP"
],
"summary": "Send an action to simulator (only available if backend server is started with -amqp parameter)",
"operationId": "sendActionToSimulator",
"parameters": [
{
"type": "string",
"description": "Action for simulator",
"name": "inputAction",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "Simulator ID",
"name": "simulatorID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Action sent successfully",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"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"
}
}
}
}
},
"/simulators/{simulatorID}/models": {
"get": {
"produces": [
"application/json"
],
"tags": [
"simulators"
],
"summary": "Get all simulation models in which the simulator is used",
"operationId": "getModelsOfSimulator",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Simulator ID",
"name": "simulatorID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Simulation models requested by user",
"schema": {
"$ref": "#/definitions/docs.ResponseSimulationModels"
}
},
"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"
}
}
}
}
},
"/users": {
"get": {
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Get all users",
"operationId": "GetUsers",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Array of users",
"schema": {
"$ref": "#/definitions/docs.ResponseUsers"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Add a user",
"operationId": "AddUser",
"parameters": [
{
"description": "User to be added",
"name": "inputUser",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.addUserRequest"
}
},
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "Contains added user object",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"422": {
"description": "Unprocessable entity",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
}
}
}
},
"/users/{userID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Get user",
"operationId": "GetUser",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "requested user",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"403": {
"description": "Access forbidden.",
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Update a user",
"operationId": "UpdateUser",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "User to be updated (anything except for ID can be changed, role can only be change by admin)",
"name": "inputUser",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.updateUserRequest"
}
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Contains updated user",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"400": {
"description": "Bad request.",
"schema": {
"$ref": "#/definitions/docs.ResponseError"
}
},
"403": {
"description": "Access forbidden.",
"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": {
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Delete a user",
"operationId": "DeleteUser",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "User ID",
"name": "userID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "deleted user",
"schema": {
"$ref": "#/definitions/docs.ResponseUser"
}
},
"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"
}
}
}
}
},
"/widgets": {
"get": {
"produces": [
"application/json"
],
"tags": [
"widgets"
],
"summary": "Get all widgets of dashboard",
"operationId": "getWidgets",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Dashboard ID",
"name": "dashboardID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Widgets to which belong to dashboard",
"schema": {
"$ref": "#/definitions/docs.ResponseWidgets"
}
},
"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"
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"widgets"
],
"summary": "Add a widget to a dashboard",
"operationId": "addWidget",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Widget to be added incl. ID of dashboard",
"name": "inputWidget",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/widget.addWidgetRequest"
}
}
],
"responses": {
"200": {
"description": "Widget that was added",
"schema": {
"$ref": "#/definitions/docs.ResponseWidget"
}
},
"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"
}
}
}
}
},
"/widgets/{widgetID}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"widgets"
],
"summary": "Get a widget",
"operationId": "getWidget",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Widget ID",
"name": "widgetID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Widget that was requested",
"schema": {
"$ref": "#/definitions/docs.ResponseWidget"
}
},
"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"
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"widgets"
],
"summary": "Update a widget",
"operationId": "updateWidget",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "Widget to be updated",
"name": "inputWidget",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/widget.updateWidgetRequest"
}
},
{
"type": "integer",
"description": "Widget ID",
"name": "widgetID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Widget that was updated",
"schema": {
"$ref": "#/definitions/docs.ResponseWidget"
}
},
"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": {
"produces": [
"application/json"
],
"tags": [
"widgets"
],
"summary": "Delete a widget",
"operationId": "deleteWidget",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "Widget ID",
"name": "widgetID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Widget that was deleted",
"schema": {
"$ref": "#/definitions/docs.ResponseWidget"
}
},
"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"
}
}
}
}
}
},
"definitions": {
"dashboard.addDashboardRequest": {
"type": "object",
"properties": {
"dashboard": {
"type": "object",
"$ref": "#/definitions/dashboard.validNewDashboard"
}
}
},
"dashboard.updateDashboardRequest": {
"type": "object",
"properties": {
"dashboard": {
"type": "object",
"$ref": "#/definitions/dashboard.validUpdatedDashboard"
}
}
},
"dashboard.validNewDashboard": {
"type": "object",
"required": [
"Grid",
"Name",
"ScenarioID"
],
"properties": {
"Grid": {
"type": "integer"
},
"Name": {
"type": "string"
},
"ScenarioID": {
"type": "integer"
}
}
},
"dashboard.validUpdatedDashboard": {
"type": "object",
"properties": {
"grid": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"database.Dashboard": {
"type": "object",
"properties": {
"grid": {
"description": "Grid of dashboard",
"type": "integer"
},
"id": {
"type": "integer"
},
"name": {
"description": "Name of dashboard",
"type": "string"
},
"scenarioID": {
"description": "ID of scenario to which dashboard belongs",
"type": "integer"
}
}
},
"database.File": {
"type": "object",
"properties": {
"date": {
"description": "Last modification time of file",
"type": "string"
},
"id": {
"type": "integer"
},
"imageHeight": {
"description": "Height of image (only needed in case of image)",
"type": "integer"
},
"imageWidth": {
"description": "Width of image (only needed in case of image)",
"type": "integer"
},
"name": {
"description": "Name of file",
"type": "string"
},
"simulationModelID": {
"description": "ID of model to which file belongs",
"type": "integer"
},
"size": {
"description": "Size of file (in byte)",
"type": "integer"
},
"type": {
"description": "Type of file (MIME type)",
"type": "string"
},
"widgetID": {
"description": "ID of widget to which file belongs",
"type": "integer"
}
}
},
"database.Scenario": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"description": "Name of scenario",
"type": "string"
},
"running": {
"description": "Running state of scenario",
"type": "boolean"
},
"startParameters": {
"description": "Start parameters of scenario as JSON",
"type": "string"
}
}
},
"database.Signal": {
"type": "object",
"properties": {
"direction": {
"description": "Direction of the signal (in or out)",
"type": "string"
},
"id": {
"type": "integer"
},
"index": {
"description": "Index of the Signal in the mapping",
"type": "integer"
},
"name": {
"description": "Name of Signal",
"type": "string"
},
"simulationModelID": {
"description": "ID of simulation model",
"type": "integer"
},
"unit": {
"description": "Unit of Signal",
"type": "string"
}
}
},
"database.SimulationModel": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"inputLength": {
"description": "Number of input signals",
"type": "integer"
},
"name": {
"description": "Name of simulation model",
"type": "string"
},
"outputLength": {
"description": "Number of output signals",
"type": "integer"
},
"scenarioID": {
"description": "ID of Scenario to which simulation model belongs",
"type": "integer"
},
"simulatorID": {
"description": "ID of simulator associated with simulation model",
"type": "integer"
},
"startParameters": {
"description": "Start parameters of simulation model as JSON",
"type": "string"
}
}
},
"database.Simulator": {
"type": "object",
"properties": {
"host": {
"description": "Host if the simulator",
"type": "string"
},
"id": {
"type": "integer"
},
"modelType": {
"description": "Model type supported by the simulator",
"type": "string"
},
"properties": {
"description": "Properties of simulator as JSON string",
"type": "string"
},
"rawProperties": {
"description": "Raw properties of simulator as JSON string",
"type": "string"
},
"state": {
"description": "State of the simulator",
"type": "string"
},
"stateUpdateAt": {
"description": "Time of last state update",
"type": "string"
},
"uptime": {
"description": "Uptime of the simulator",
"type": "integer"
},
"uuid": {
"description": "UUID of the simulator",
"type": "string"
}
}
},
"database.User": {
"type": "object",
"properties": {
"active": {
"description": "Indicating status of user (false means user is inactive and should not be able to login)",
"type": "boolean"
},
"id": {
"type": "integer"
},
"mail": {
"description": "Mail of user",
"type": "string"
},
"role": {
"description": "Role of user",
"type": "string"
},
"username": {
"description": "Username of user",
"type": "string"
}
}
},
"database.Widget": {
"type": "object",
"properties": {
"customProperties": {
"description": "Custom properties of widget as JSON string",
"type": "string"
},
"dashboardID": {
"description": "ID of dashboard to which widget belongs",
"type": "integer"
},
"height": {
"description": "Height of widget",
"type": "integer"
},
"id": {
"type": "integer"
},
"isLocked": {
"description": "Locked state of widget",
"type": "boolean"
},
"minHeight": {
"description": "Minimal height of widget",
"type": "integer"
},
"minWidth": {
"description": "Minimal width of widget",
"type": "integer"
},
"name": {
"description": "Name of widget",
"type": "string"
},
"type": {
"description": "Type of widget",
"type": "string"
},
"width": {
"description": "Width of widget",
"type": "integer"
},
"x": {
"description": "X position of widget",
"type": "integer"
},
"y": {
"description": "Y position of widget",
"type": "integer"
},
"z": {
"description": "Z position of widget",
"type": "integer"
}
}
},
"docs.ResponseAuthenticate": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"success": {
"type": "boolean"
},
"token": {
"type": "string"
},
"user": {
"type": "object",
"$ref": "#/definitions/database.User"
}
}
},
"docs.ResponseDashboard": {
"type": "object",
"properties": {
"dashboard": {
"type": "object",
"$ref": "#/definitions/database.Dashboard"
}
}
},
"docs.ResponseDashboards": {
"type": "object",
"properties": {
"dashboards": {
"type": "array",
"items": {
"$ref": "#/definitions/database.Dashboard"
}
}
}
},
"docs.ResponseError": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"docs.ResponseFile": {
"type": "object",
"properties": {
"file": {
"type": "object",
"$ref": "#/definitions/database.File"
}
}
},
"docs.ResponseFiles": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/database.File"
}
}
}
},
"docs.ResponseScenario": {
"type": "object",
"properties": {
"scenario": {
"type": "object",
"$ref": "#/definitions/database.Scenario"
}
}
},
"docs.ResponseScenarios": {
"type": "object",
"properties": {
"scenarios": {
"type": "array",
"items": {
"$ref": "#/definitions/database.Scenario"
}
}
}
},
"docs.ResponseSignal": {
"type": "object",
"properties": {
"signal": {
"type": "object",
"$ref": "#/definitions/database.Signal"
}
}
},
"docs.ResponseSignals": {
"type": "object",
"properties": {
"signals": {
"type": "array",
"items": {
"$ref": "#/definitions/database.Signal"
}
}
}
},
"docs.ResponseSimulationModel": {
"type": "object",
"properties": {
"model": {
"type": "object",
"$ref": "#/definitions/database.SimulationModel"
}
}
},
"docs.ResponseSimulationModels": {
"type": "object",
"properties": {
"models": {
"type": "array",
"items": {
"$ref": "#/definitions/database.SimulationModel"
}
}
}
},
"docs.ResponseSimulator": {
"type": "object",
"properties": {
"simulator": {
"type": "object",
"$ref": "#/definitions/database.Simulator"
}
}
},
"docs.ResponseSimulators": {
"type": "object",
"properties": {
"simulators": {
"type": "array",
"items": {
"$ref": "#/definitions/database.Simulator"
}
}
}
},
"docs.ResponseUser": {
"type": "object",
"properties": {
"user": {
"type": "object",
"$ref": "#/definitions/database.User"
}
}
},
"docs.ResponseUsers": {
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/database.User"
}
}
}
},
"docs.ResponseWidget": {
"type": "object",
"properties": {
"widget": {
"type": "object",
"$ref": "#/definitions/database.Widget"
}
}
},
"docs.ResponseWidgets": {
"type": "object",
"properties": {
"widgets": {
"type": "array",
"items": {
"$ref": "#/definitions/database.Widget"
}
}
}
},
"scenario.addScenarioRequest": {
"type": "object",
"properties": {
"scenario": {
"type": "object",
"$ref": "#/definitions/scenario.validNewScenario"
}
}
},
"scenario.updateScenarioRequest": {
"type": "object",
"properties": {
"scenario": {
"type": "object",
"$ref": "#/definitions/scenario.validUpdatedScenario"
}
}
},
"scenario.validNewScenario": {
"type": "object",
"required": [
"Name",
"StartParameters"
],
"properties": {
"Name": {
"type": "string"
},
"Running": {
"type": "boolean"
},
"StartParameters": {
"type": "string"
}
}
},
"scenario.validUpdatedScenario": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Running": {
"type": "boolean"
},
"StartParameters": {
"type": "string"
}
}
},
"signal.addSignalRequest": {
"type": "object",
"properties": {
"signal": {
"type": "object",
"$ref": "#/definitions/signal.validNewSignal"
}
}
},
"signal.updateSignalRequest": {
"type": "object",
"properties": {
"signal": {
"type": "object",
"$ref": "#/definitions/signal.validUpdatedSignal"
}
}
},
"signal.validNewSignal": {
"type": "object",
"required": [
"Direction",
"Index",
"Name",
"SimulationModelID"
],
"properties": {
"Direction": {
"type": "string"
},
"Index": {
"type": "integer"
},
"Name": {
"type": "string"
},
"SimulationModelID": {
"type": "integer"
},
"Unit": {
"type": "string"
}
}
},
"signal.validUpdatedSignal": {
"type": "object",
"properties": {
"Index": {
"type": "integer"
},
"Name": {
"type": "string"
},
"Unit": {
"type": "string"
}
}
},
"simulationmodel.addSimulationModelRequest": {
"type": "object",
"properties": {
"model": {
"type": "object",
"$ref": "#/definitions/simulationmodel.validNewSimulationModel"
}
}
},
"simulationmodel.updateSimulationModelRequest": {
"type": "object",
"properties": {
"model": {
"type": "object",
"$ref": "#/definitions/simulationmodel.validUpdatedSimulationModel"
}
}
},
"simulationmodel.validNewSimulationModel": {
"type": "object",
"required": [
"Name",
"ScenarioID",
"SimulatorID",
"StartParameters"
],
"properties": {
"Name": {
"type": "string"
},
"ScenarioID": {
"type": "integer"
},
"SimulatorID": {
"type": "integer"
},
"StartParameters": {
"type": "string"
}
}
},
"simulationmodel.validUpdatedSimulationModel": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"SimulatorID": {
"type": "integer"
},
"StartParameters": {
"type": "string"
}
}
},
"simulator.addSimulatorRequest": {
"type": "object",
"properties": {
"simulator": {
"type": "object",
"$ref": "#/definitions/simulator.validNewSimulator"
}
}
},
"simulator.updateSimulatorRequest": {
"type": "object",
"properties": {
"simulator": {
"type": "object",
"$ref": "#/definitions/simulator.validUpdatedSimulator"
}
}
},
"simulator.validNewSimulator": {
"type": "object",
"required": [
"Host",
"Modeltype",
"Properties",
"UUID"
],
"properties": {
"Host": {
"type": "string"
},
"Modeltype": {
"type": "string"
},
"Properties": {
"type": "string"
},
"State": {
"type": "string"
},
"UUID": {
"type": "string"
}
}
},
"simulator.validUpdatedSimulator": {
"type": "object",
"properties": {
"Host": {
"type": "string"
},
"Modeltype": {
"type": "string"
},
"Properties": {
"type": "string"
},
"State": {
"type": "string"
},
"UUID": {
"type": "string"
}
}
},
"user.addUserRequest": {
"type": "object",
"properties": {
"user": {
"type": "object",
"$ref": "#/definitions/user.validNewUser"
}
}
},
"user.loginRequest": {
"type": "object",
"required": [
"Password",
"Username"
],
"properties": {
"Password": {
"type": "string"
},
"Username": {
"type": "string"
}
}
},
"user.updateUserRequest": {
"type": "object",
"properties": {
"user": {
"type": "object",
"$ref": "#/definitions/user.validUpdatedRequest"
}
}
},
"user.validNewUser": {
"type": "object",
"required": [
"Mail",
"Password",
"Role",
"Username"
],
"properties": {
"Mail": {
"type": "string"
},
"Password": {
"type": "string"
},
"Role": {
"type": "string"
},
"Username": {
"type": "string"
}
}
},
"user.validUpdatedRequest": {
"type": "object",
"properties": {
"Active": {
"type": "string"
},
"Mail": {
"type": "string"
},
"OldPassword": {
"type": "string"
},
"Password": {
"type": "string"
},
"Role": {
"type": "string"
},
"Username": {
"type": "string"
}
}
},
"widget.addWidgetRequest": {
"type": "object",
"properties": {
"widget": {
"type": "object",
"$ref": "#/definitions/widget.validNewWidget"
}
}
},
"widget.updateWidgetRequest": {
"type": "object",
"properties": {
"widget": {
"type": "object",
"$ref": "#/definitions/widget.validUpdatedWidget"
}
}
},
"widget.validNewWidget": {
"type": "object",
"required": [
"DashboardID",
"Height",
"Name",
"Type",
"Width"
],
"properties": {
"CustomProperties": {
"type": "string"
},
"DashboardID": {
"type": "integer"
},
"Height": {
"type": "integer"
},
"IsLocked": {
"type": "boolean"
},
"MinHeight": {
"type": "integer"
},
"MinWidth": {
"type": "integer"
},
"Name": {
"type": "string"
},
"Type": {
"type": "string"
},
"Width": {
"type": "integer"
},
"X": {
"type": "integer"
},
"Y": {
"type": "integer"
},
"Z": {
"type": "integer"
}
}
},
"widget.validUpdatedWidget": {
"type": "object",
"properties": {
"CustomProperties": {
"type": "string"
},
"Height": {
"type": "integer"
},
"IsLocked": {
"type": "boolean"
},
"MinHeight": {
"type": "integer"
},
"MinWidth": {
"type": "integer"
},
"Name": {
"type": "string"
},
"Type": {
"type": "string"
},
"Width": {
"type": "integer"
},
"X": {
"type": "integer"
},
"Y": {
"type": "integer"
},
"Z": {
"type": "integer"
}
}
}
}
}`
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "2.0",
Host: "",
BasePath: "/api/v2",
Schemes: []string{},
Title: "VILLASweb Backend API",
Description: "This is the VILLASweb Backend API v2.0.\nParts of this API are still in development. Please check the [VILLASweb-backend-go repository](https://git.rwth-aachen.de/acs/public/villas/web-backend-go) for more information.\nThis documentation is auto-generated based on the API documentation in the code. The tool [swag](https://github.com/swaggo/swag) is used to auto-generate API docs for the [gin-gonic](https://github.com/gin-gonic/gin) framework.",
}
type s struct{}
func (s *s) ReadDoc() string {
sInfo := SwaggerInfo
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v interface{}) string {
a, _ := json.Marshal(v)
return string(a)
},
}).Parse(doc)
if err != nil {
return doc
}
var tpl bytes.Buffer
if err := t.Execute(&tpl, sInfo); err != nil {
return doc
}
return tpl.String()
}
func init() {
swag.Register(swag.Name, &s{})
}
Reference in a new issue View git blame Copy permalink