From 0119a2947e1523ab89beece5801abb18e6fda47b Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Wed, 13 Nov 2019 20:52:58 +0100 Subject: [PATCH] swaggo: update generated docs --- doc/api/docs.go | 242 ++++--------------------------------------- doc/api/swagger.json | 216 -------------------------------------- doc/api/swagger.yaml | 216 -------------------------------------- 3 files changed, 19 insertions(+), 655 deletions(-) diff --git a/doc/api/docs.go b/doc/api/docs.go index 1e0e093..06e00a1 100644 --- a/doc/api/docs.go +++ b/doc/api/docs.go @@ -1,12 +1,13 @@ // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT // This file was generated by swaggo/swag at -// 2019-11-13 15:00:23.644372933 +0100 CET m=+0.089025380 +// 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" @@ -16,8 +17,8 @@ var doc = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { - "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.", - "title": "VILLASweb Backend API", + "description": "{{.Description}}", + "title": "{{.Title}}", "contact": { "name": "Sonja Happ", "email": "sonja.happ@eonerc.rwth-aachen.de" @@ -26,10 +27,10 @@ var doc = `{ "name": "GNU GPL 3.0", "url": "http://www.gnu.de/documents/gpl-3.0.en.html" }, - "version": "2.0" + "version": "{{.Version}}" }, - "host": "localhost:4000", - "basePath": "/api/v2", + "host": "{{.Host}}", + "basePath": "{{.BasePath}}", "paths": { "/authenticate": { "post": { @@ -60,21 +61,18 @@ var doc = `{ "200": { "description": "JSON web token, success status, message and authenticated user object", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseAuthenticate" } }, "401": { "description": "Unauthorized", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -111,28 +109,24 @@ var doc = `{ "200": { "description": "Dashboards which belong to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboards" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -173,35 +167,30 @@ var doc = `{ "200": { "description": "Dashboard that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -238,35 +227,30 @@ var doc = `{ "200": { "description": "Dashboard that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -314,35 +298,30 @@ var doc = `{ "200": { "description": "Dashboard that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -377,35 +356,30 @@ var doc = `{ "200": { "description": "Dashboard that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -449,28 +423,24 @@ var doc = `{ "200": { "description": "Files which belong to simulation model or widget", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFiles" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -527,35 +497,30 @@ var doc = `{ "200": { "description": "File that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -597,35 +562,30 @@ var doc = `{ "200": { "description": "File that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -675,35 +635,30 @@ var doc = `{ "200": { "description": "File that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -738,35 +693,30 @@ var doc = `{ "200": { "description": "File that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -799,7 +749,6 @@ var doc = `{ "500": { "description": "Backend is NOT healthy", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -836,28 +785,24 @@ var doc = `{ "200": { "description": "Simulation models which belong to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModels" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -898,35 +843,30 @@ var doc = `{ "200": { "description": "simulation model that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -963,35 +903,30 @@ var doc = `{ "200": { "description": "simulation model that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1039,35 +974,30 @@ var doc = `{ "200": { "description": "simulation model that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1102,35 +1032,30 @@ var doc = `{ "200": { "description": "simulation model that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1160,28 +1085,24 @@ var doc = `{ "200": { "description": "Scenarios to which user has access", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenarios" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1222,35 +1143,30 @@ var doc = `{ "200": { "description": "scenario that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1287,28 +1203,24 @@ var doc = `{ "200": { "description": "Scenario requested by user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1356,35 +1268,30 @@ var doc = `{ "200": { "description": "Updated scenario.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1419,28 +1326,24 @@ var doc = `{ "200": { "description": "Deleted scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1484,28 +1387,24 @@ var doc = `{ "200": { "description": "User that was added to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1547,28 +1446,24 @@ var doc = `{ "200": { "description": "User that was deleted from scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1605,28 +1500,24 @@ var doc = `{ "200": { "description": "Array of users that have access to the scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1670,28 +1561,24 @@ var doc = `{ "200": { "description": "Signals which belong to simulation model", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignals" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1732,35 +1619,30 @@ var doc = `{ "200": { "description": "Signal that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1797,35 +1679,30 @@ var doc = `{ "200": { "description": "Signal that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1870,35 +1747,30 @@ var doc = `{ "200": { "description": "Signal that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1933,35 +1805,30 @@ var doc = `{ "200": { "description": "Signal that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1991,28 +1858,24 @@ var doc = `{ "200": { "description": "Simulators requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulators" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2053,35 +1916,30 @@ var doc = `{ "200": { "description": "Simulator that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2118,35 +1976,30 @@ var doc = `{ "200": { "description": "Simulator that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2194,35 +2047,30 @@ var doc = `{ "200": { "description": "Simulator that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2257,35 +2105,30 @@ var doc = `{ "200": { "description": "Simulator that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2322,35 +2165,30 @@ var doc = `{ "200": { "description": "Action sent successfully", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2387,35 +2225,30 @@ var doc = `{ "200": { "description": "Simulation models requested by user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModels" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2445,28 +2278,24 @@ var doc = `{ "200": { "description": "Array of users", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2507,28 +2336,24 @@ var doc = `{ "200": { "description": "Contains added user object", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2565,35 +2390,30 @@ var doc = `{ "200": { "description": "requested user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "403": { "description": "Access forbidden.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2641,42 +2461,36 @@ var doc = `{ "200": { "description": "Contains updated user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "400": { "description": "Bad request.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "403": { "description": "Access forbidden.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2711,28 +2525,24 @@ var doc = `{ "200": { "description": "deleted user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2769,28 +2579,24 @@ var doc = `{ "200": { "description": "Widgets to which belong to dashboard", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidgets" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2831,35 +2637,30 @@ var doc = `{ "200": { "description": "Widget that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2896,35 +2697,30 @@ var doc = `{ "200": { "description": "Widget that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2972,35 +2768,30 @@ var doc = `{ "200": { "description": "Widget that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -3035,35 +2826,30 @@ var doc = `{ "200": { "description": "Widget that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -3992,11 +3778,21 @@ type swaggerInfo struct { } // SwaggerInfo holds exported Swagger Info so clients can modify it -var SwaggerInfo = swaggerInfo{Schemes: []string{}} +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) @@ -4008,7 +3804,7 @@ func (s *s) ReadDoc() string { } var tpl bytes.Buffer - if err := t.Execute(&tpl, SwaggerInfo); err != nil { + if err := t.Execute(&tpl, sInfo); err != nil { return doc } diff --git a/doc/api/swagger.json b/doc/api/swagger.json index a9fe6e4..908d1c4 100644 --- a/doc/api/swagger.json +++ b/doc/api/swagger.json @@ -13,7 +13,6 @@ }, "version": "2.0" }, - "host": "localhost:4000", "basePath": "/api/v2", "paths": { "/authenticate": { @@ -45,21 +44,18 @@ "200": { "description": "JSON web token, success status, message and authenticated user object", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseAuthenticate" } }, "401": { "description": "Unauthorized", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -96,28 +92,24 @@ "200": { "description": "Dashboards which belong to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboards" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -158,35 +150,30 @@ "200": { "description": "Dashboard that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -223,35 +210,30 @@ "200": { "description": "Dashboard that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -299,35 +281,30 @@ "200": { "description": "Dashboard that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -362,35 +339,30 @@ "200": { "description": "Dashboard that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -434,28 +406,24 @@ "200": { "description": "Files which belong to simulation model or widget", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFiles" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -512,35 +480,30 @@ "200": { "description": "File that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -582,35 +545,30 @@ "200": { "description": "File that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -660,35 +618,30 @@ "200": { "description": "File that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -723,35 +676,30 @@ "200": { "description": "File that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -784,7 +732,6 @@ "500": { "description": "Backend is NOT healthy", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -821,28 +768,24 @@ "200": { "description": "Simulation models which belong to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModels" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -883,35 +826,30 @@ "200": { "description": "simulation model that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -948,35 +886,30 @@ "200": { "description": "simulation model that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1024,35 +957,30 @@ "200": { "description": "simulation model that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1087,35 +1015,30 @@ "200": { "description": "simulation model that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModel" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1145,28 +1068,24 @@ "200": { "description": "Scenarios to which user has access", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenarios" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1207,35 +1126,30 @@ "200": { "description": "scenario that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1272,28 +1186,24 @@ "200": { "description": "Scenario requested by user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1341,35 +1251,30 @@ "200": { "description": "Updated scenario.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1404,28 +1309,24 @@ "200": { "description": "Deleted scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1469,28 +1370,24 @@ "200": { "description": "User that was added to scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1532,28 +1429,24 @@ "200": { "description": "User that was deleted from scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1590,28 +1483,24 @@ "200": { "description": "Array of users that have access to the scenario", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1655,28 +1544,24 @@ "200": { "description": "Signals which belong to simulation model", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignals" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1717,35 +1602,30 @@ "200": { "description": "Signal that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1782,35 +1662,30 @@ "200": { "description": "Signal that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1855,35 +1730,30 @@ "200": { "description": "Signal that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1918,35 +1788,30 @@ "200": { "description": "Signal that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -1976,28 +1841,24 @@ "200": { "description": "Simulators requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulators" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2038,35 +1899,30 @@ "200": { "description": "Simulator that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2103,35 +1959,30 @@ "200": { "description": "Simulator that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2179,35 +2030,30 @@ "200": { "description": "Simulator that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2242,35 +2088,30 @@ "200": { "description": "Simulator that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulator" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2307,35 +2148,30 @@ "200": { "description": "Action sent successfully", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2372,35 +2208,30 @@ "200": { "description": "Simulation models requested by user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseSimulationModels" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2430,28 +2261,24 @@ "200": { "description": "Array of users", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2492,28 +2319,24 @@ "200": { "description": "Contains added user object", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2550,35 +2373,30 @@ "200": { "description": "requested user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "403": { "description": "Access forbidden.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2626,42 +2444,36 @@ "200": { "description": "Contains updated user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "400": { "description": "Bad request.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "403": { "description": "Access forbidden.", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2696,28 +2508,24 @@ "200": { "description": "deleted user", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2754,28 +2562,24 @@ "200": { "description": "Widgets to which belong to dashboard", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidgets" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2816,35 +2620,30 @@ "200": { "description": "Widget that was added", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2881,35 +2680,30 @@ "200": { "description": "Widget that was requested", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -2957,35 +2751,30 @@ "200": { "description": "Widget that was updated", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } @@ -3020,35 +2809,30 @@ "200": { "description": "Widget that was deleted", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "404": { "description": "Not found", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "type": "object", "$ref": "#/definitions/docs.ResponseError" } } diff --git a/doc/api/swagger.yaml b/doc/api/swagger.yaml index cb0175a..cf2a992 100644 --- a/doc/api/swagger.yaml +++ b/doc/api/swagger.yaml @@ -618,7 +618,6 @@ definitions: Z: type: integer type: object -host: localhost:4000 info: contact: email: sonja.happ@eonerc.rwth-aachen.de @@ -654,17 +653,14 @@ paths: object schema: $ref: '#/definitions/docs.ResponseAuthenticate' - type: object "401": description: Unauthorized schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error. schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Authentication for user tags: - authentication @@ -689,22 +685,18 @@ paths: description: Dashboards which belong to scenario schema: $ref: '#/definitions/docs.ResponseDashboards' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all dashboards of scenario tags: - dashboards @@ -732,27 +724,22 @@ paths: description: Dashboard that was added schema: $ref: '#/definitions/docs.ResponseDashboard' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a dashboard to a scenario tags: - dashboards @@ -777,27 +764,22 @@ paths: description: Dashboard that was deleted schema: $ref: '#/definitions/docs.ResponseDashboard' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a dashboard tags: - dashboards @@ -821,27 +803,22 @@ paths: description: Dashboard that was requested schema: $ref: '#/definitions/docs.ResponseDashboard' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get a dashboard tags: - dashboards @@ -874,27 +851,22 @@ paths: description: Dashboard that was updated schema: $ref: '#/definitions/docs.ResponseDashboard' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a dashboard tags: - dashboards @@ -924,22 +896,18 @@ paths: description: Files which belong to simulation model or widget schema: $ref: '#/definitions/docs.ResponseFiles' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all files of a specific model or widget tags: - files @@ -980,27 +948,22 @@ paths: description: File that was added schema: $ref: '#/definitions/docs.ResponseFile' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a file to a specific model or widget tags: - files @@ -1025,27 +988,22 @@ paths: description: File that was deleted schema: $ref: '#/definitions/docs.ResponseFile' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a file tags: - files @@ -1074,27 +1032,22 @@ paths: description: File that was requested schema: $ref: '#/definitions/docs.ResponseFile' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Download a file tags: - files @@ -1130,27 +1083,22 @@ paths: description: File that was updated schema: $ref: '#/definitions/docs.ResponseFile' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a file tags: - files @@ -1173,7 +1121,6 @@ paths: description: Backend is NOT healthy schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get health status of backend tags: - healthz @@ -1198,22 +1145,18 @@ paths: description: Simulation models which belong to scenario schema: $ref: '#/definitions/docs.ResponseSimulationModels' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all simulation models of scenario tags: - models @@ -1241,27 +1184,22 @@ paths: description: simulation model that was added schema: $ref: '#/definitions/docs.ResponseSimulationModel' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a simulation model to a scenario tags: - models @@ -1286,27 +1224,22 @@ paths: description: simulation model that was deleted schema: $ref: '#/definitions/docs.ResponseSimulationModel' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a simulation model tags: - models @@ -1330,27 +1263,22 @@ paths: description: simulation model that was requested schema: $ref: '#/definitions/docs.ResponseSimulationModel' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get a simulation model tags: - models @@ -1383,27 +1311,22 @@ paths: description: simulation model that was added schema: $ref: '#/definitions/docs.ResponseSimulationModel' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a simulation model tags: - models @@ -1423,22 +1346,18 @@ paths: description: Scenarios to which user has access schema: $ref: '#/definitions/docs.ResponseScenarios' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all scenarios of requesting user tags: - scenarios @@ -1466,27 +1385,22 @@ paths: description: scenario that was added schema: $ref: '#/definitions/docs.ResponseScenario' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a scenario tags: - scenarios @@ -1511,22 +1425,18 @@ paths: description: Deleted scenario schema: $ref: '#/definitions/docs.ResponseScenario' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a scenario tags: - scenarios @@ -1550,22 +1460,18 @@ paths: description: Scenario requested by user schema: $ref: '#/definitions/docs.ResponseScenario' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get scenario tags: - scenarios @@ -1598,27 +1504,22 @@ paths: description: Updated scenario. schema: $ref: '#/definitions/docs.ResponseScenario' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a scenario tags: - scenarios @@ -1648,22 +1549,18 @@ paths: description: User that was deleted from scenario schema: $ref: '#/definitions/docs.ResponseUser' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a user from a scenario tags: - scenarios @@ -1692,22 +1589,18 @@ paths: description: User that was added to scenario schema: $ref: '#/definitions/docs.ResponseUser' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a user to a a scenario tags: - scenarios @@ -1732,22 +1625,18 @@ paths: description: Array of users that have access to the scenario schema: $ref: '#/definitions/docs.ResponseUsers' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get users of a scenario tags: - scenarios @@ -1777,22 +1666,18 @@ paths: description: Signals which belong to simulation model schema: $ref: '#/definitions/docs.ResponseSignals' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all signals of one direction tags: - signals @@ -1821,27 +1706,22 @@ paths: description: Signal that was added schema: $ref: '#/definitions/docs.ResponseSignal' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a signal to a signal mapping of a model tags: - signals @@ -1866,27 +1746,22 @@ paths: description: Signal that was deleted schema: $ref: '#/definitions/docs.ResponseSignal' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a signal tags: - signals @@ -1910,27 +1785,22 @@ paths: description: Signal that was requested schema: $ref: '#/definitions/docs.ResponseSignal' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get a signal tags: - signals @@ -1961,27 +1831,22 @@ paths: description: Signal that was updated schema: $ref: '#/definitions/docs.ResponseSignal' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a signal tags: - signals @@ -2001,22 +1866,18 @@ paths: description: Simulators requested schema: $ref: '#/definitions/docs.ResponseSimulators' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all simulators tags: - simulators @@ -2044,27 +1905,22 @@ paths: description: Simulator that was added schema: $ref: '#/definitions/docs.ResponseSimulator' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a simulator tags: - simulators @@ -2089,27 +1945,22 @@ paths: description: Simulator that was deleted schema: $ref: '#/definitions/docs.ResponseSimulator' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a simulator tags: - simulators @@ -2133,27 +1984,22 @@ paths: description: Simulator that was requested schema: $ref: '#/definitions/docs.ResponseSimulator' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get simulator tags: - simulators @@ -2186,27 +2032,22 @@ paths: description: Simulator that was updated schema: $ref: '#/definitions/docs.ResponseSimulator' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a simulator tags: - simulators @@ -2231,27 +2072,22 @@ paths: description: Action sent successfully schema: $ref: '#/definitions/docs.ResponseError' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Send an action to simulator (only available if backend server is started with -amqp parameter) tags: @@ -2277,27 +2113,22 @@ paths: description: Simulation models requested by user schema: $ref: '#/definitions/docs.ResponseSimulationModels' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all simulation models in which the simulator is used tags: - simulators @@ -2317,22 +2148,18 @@ paths: description: Array of users schema: $ref: '#/definitions/docs.ResponseUsers' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all users tags: - users @@ -2360,22 +2187,18 @@ paths: description: Contains added user object schema: $ref: '#/definitions/docs.ResponseUser' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a user tags: - users @@ -2400,22 +2223,18 @@ paths: description: deleted user schema: $ref: '#/definitions/docs.ResponseUser' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a user tags: - users @@ -2439,27 +2258,22 @@ paths: description: requested user schema: $ref: '#/definitions/docs.ResponseUser' - type: object "403": description: Access forbidden. schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get user tags: - users @@ -2493,32 +2307,26 @@ paths: description: Contains updated user schema: $ref: '#/definitions/docs.ResponseUser' - type: object "400": description: Bad request. schema: $ref: '#/definitions/docs.ResponseError' - type: object "403": description: Access forbidden. schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a user tags: - users @@ -2543,22 +2351,18 @@ paths: description: Widgets to which belong to dashboard schema: $ref: '#/definitions/docs.ResponseWidgets' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get all widgets of dashboard tags: - widgets @@ -2586,27 +2390,22 @@ paths: description: Widget that was added schema: $ref: '#/definitions/docs.ResponseWidget' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Add a widget to a dashboard tags: - widgets @@ -2631,27 +2430,22 @@ paths: description: Widget that was deleted schema: $ref: '#/definitions/docs.ResponseWidget' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Delete a widget tags: - widgets @@ -2675,27 +2469,22 @@ paths: description: Widget that was requested schema: $ref: '#/definitions/docs.ResponseWidget' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Get a widget tags: - widgets @@ -2728,27 +2517,22 @@ paths: description: Widget that was updated schema: $ref: '#/definitions/docs.ResponseWidget' - type: object "400": description: Bad request schema: $ref: '#/definitions/docs.ResponseError' - type: object "404": description: Not found schema: $ref: '#/definitions/docs.ResponseError' - type: object "422": description: Unprocessable entity schema: $ref: '#/definitions/docs.ResponseError' - type: object "500": description: Internal server error schema: $ref: '#/definitions/docs.ResponseError' - type: object summary: Update a widget tags: - widgets