diff --git a/doc/api/docs.go b/doc/api/docs.go index e17cda2..94f5c23 100644 --- a/doc/api/docs.go +++ b/doc/api/docs.go @@ -1,8 +1,7 @@ // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT -// This file was generated by swaggo/swag at -// 2021-01-12 17:04:27.751319166 +0100 CET m=+0.123714746 +// This file was generated by swaggo/swag -package docs +package api import ( "bytes" @@ -52,7 +51,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.loginRequest" } } @@ -61,19 +59,19 @@ var doc = `{ "200": { "description": "JSON web token, success status, message and authenticated user object", "schema": { - "$ref": "#/definitions/docs.ResponseAuthenticate" + "$ref": "#/definitions/api.ResponseAuthenticate" } }, "401": { "description": "Unauthorized", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -107,25 +105,25 @@ var doc = `{ "200": { "description": "Component configurations which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseConfigs" + "$ref": "#/definitions/api.ResponseConfigs" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -154,7 +152,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/component_configuration.addConfigRequest" } } @@ -163,31 +160,31 @@ var doc = `{ "200": { "description": "Component configuration that was added", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -221,31 +218,31 @@ var doc = `{ "200": { "description": "component configuration that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -274,7 +271,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/component_configuration.updateConfigRequest" } }, @@ -290,31 +286,31 @@ var doc = `{ "200": { "description": "Component configuration that was added", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -346,31 +342,31 @@ var doc = `{ "200": { "description": "component configuration that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -404,25 +400,25 @@ var doc = `{ "200": { "description": "Dashboards which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseDashboards" + "$ref": "#/definitions/api.ResponseDashboards" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -451,7 +447,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/dashboard.addDashboardRequest" } } @@ -460,31 +455,31 @@ var doc = `{ "200": { "description": "Dashboard that was added", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -518,31 +513,31 @@ var doc = `{ "200": { "description": "Dashboard that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -571,7 +566,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/dashboard.updateDashboardRequest" } }, @@ -587,31 +581,31 @@ var doc = `{ "200": { "description": "Dashboard that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -643,31 +637,31 @@ var doc = `{ "200": { "description": "Dashboard that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -701,25 +695,25 @@ var doc = `{ "200": { "description": "Files which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseFiles" + "$ref": "#/definitions/api.ResponseFiles" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -767,31 +761,31 @@ var doc = `{ "200": { "description": "File that was added", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -839,31 +833,31 @@ var doc = `{ "200": { "description": "File that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -911,31 +905,31 @@ var doc = `{ "200": { "description": "File that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -967,31 +961,31 @@ var doc = `{ "200": { "description": "File that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1008,13 +1002,16 @@ var doc = `{ "summary": "Get health status of backend", "operationId": "getHealth", "responses": { - "200": { - "description": "Backend is healthy, database and AMQP broker connections are alive" + "204": { + "description": "Backend is healthy, database and AMQP broker connections are alive", + "schema": { + "type": "string" + } }, "500": { "description": "Backend is NOT healthy", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1039,25 +1036,25 @@ var doc = `{ "200": { "description": "ICs requested", "schema": { - "$ref": "#/definitions/docs.ResponseICs" + "$ref": "#/definitions/api.ResponseICs" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1086,7 +1083,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/infrastructure_component.AddICRequest" } } @@ -1095,31 +1091,31 @@ var doc = `{ "200": { "description": "Infrastructure Component that was added", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1153,31 +1149,31 @@ var doc = `{ "200": { "description": "Infrastructure Component that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1206,7 +1202,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/infrastructure_component.UpdateICRequest" } }, @@ -1222,31 +1217,31 @@ var doc = `{ "200": { "description": "Infrastructure Component that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1278,31 +1273,31 @@ var doc = `{ "200": { "description": "Infrastructure Component that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1343,31 +1338,31 @@ var doc = `{ "200": { "description": "Action sent successfully", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1401,31 +1396,31 @@ var doc = `{ "200": { "description": "Configs requested by user", "schema": { - "$ref": "#/definitions/docs.ResponseConfigs" + "$ref": "#/definitions/api.ResponseConfigs" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1443,7 +1438,30 @@ var doc = `{ "operationId": "getMetrics", "responses": { "200": { - "description": "Returns Prometheus metrics" + "description": "Returns Prometheus metrics", + "schema": { + "type": "string" + } + } + } + } + }, + "/openapi": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "openapi" + ], + "summary": "Get OpenAPI 2.0 spec of API", + "operationId": "getOpenAPI", + "responses": { + "200": { + "description": "A OpenAPI 2.0 specification of the API", + "schema": { + "type": "string" + } } } } @@ -1476,25 +1494,25 @@ var doc = `{ "200": { "description": "Results which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseResults" + "$ref": "#/definitions/api.ResponseResults" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1523,7 +1541,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/result.addResultRequest" } } @@ -1532,31 +1549,31 @@ var doc = `{ "200": { "description": "Result that was added", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1590,31 +1607,31 @@ var doc = `{ "200": { "description": "Result that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1643,7 +1660,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/result.updateResultRequest" } }, @@ -1659,31 +1675,31 @@ var doc = `{ "200": { "description": "Result that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1715,31 +1731,31 @@ var doc = `{ "200": { "description": "Result that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1792,31 +1808,31 @@ var doc = `{ "200": { "description": "Result that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1857,31 +1873,31 @@ var doc = `{ "200": { "description": "Result for which file was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1906,25 +1922,25 @@ var doc = `{ "200": { "description": "Scenarios to which user has access", "schema": { - "$ref": "#/definitions/docs.ResponseScenarios" + "$ref": "#/definitions/api.ResponseScenarios" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1953,7 +1969,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/scenario.addScenarioRequest" } } @@ -1962,31 +1977,31 @@ var doc = `{ "200": { "description": "scenario that was added", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2020,25 +2035,25 @@ var doc = `{ "200": { "description": "Scenario requested by user", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2067,7 +2082,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/scenario.updateScenarioRequest" } }, @@ -2083,31 +2097,31 @@ var doc = `{ "200": { "description": "Updated scenario.", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2139,25 +2153,25 @@ var doc = `{ "200": { "description": "Deleted scenario", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2198,25 +2212,25 @@ var doc = `{ "200": { "description": "User that was added to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2255,25 +2269,25 @@ var doc = `{ "200": { "description": "User that was deleted from scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2307,25 +2321,25 @@ var doc = `{ "200": { "description": "Array of users that have access to the scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUsers" + "$ref": "#/definitions/api.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2366,25 +2380,25 @@ var doc = `{ "200": { "description": "Signals which belong to component configuration", "schema": { - "$ref": "#/definitions/docs.ResponseSignals" + "$ref": "#/definitions/api.ResponseSignals" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2413,7 +2427,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/signal.addSignalRequest" } } @@ -2422,31 +2435,31 @@ var doc = `{ "200": { "description": "Signal that was added", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2480,31 +2493,31 @@ var doc = `{ "200": { "description": "Signal that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2530,7 +2543,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/signal.updateSignalRequest" } }, @@ -2546,31 +2558,31 @@ var doc = `{ "200": { "description": "Signal that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2602,31 +2614,31 @@ var doc = `{ "200": { "description": "Signal that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2651,25 +2663,25 @@ var doc = `{ "200": { "description": "Array of users", "schema": { - "$ref": "#/definitions/docs.ResponseUsers" + "$ref": "#/definitions/api.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2698,7 +2710,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.addUserRequest" } } @@ -2707,25 +2718,25 @@ var doc = `{ "200": { "description": "Contains added user object", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2759,31 +2770,31 @@ var doc = `{ "200": { "description": "requested user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "403": { "description": "Access forbidden.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2812,7 +2823,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.updateUserRequest" } }, @@ -2828,37 +2838,37 @@ var doc = `{ "200": { "description": "Contains updated user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "400": { "description": "Bad request.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "403": { "description": "Access forbidden.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2890,25 +2900,25 @@ var doc = `{ "200": { "description": "deleted user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2942,25 +2952,25 @@ var doc = `{ "200": { "description": "Widgets to which belong to dashboard", "schema": { - "$ref": "#/definitions/docs.ResponseWidgets" + "$ref": "#/definitions/api.ResponseWidgets" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2989,7 +2999,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/widget.addWidgetRequest" } } @@ -2998,31 +3007,31 @@ var doc = `{ "200": { "description": "Widget that was added", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3056,31 +3065,31 @@ var doc = `{ "200": { "description": "Widget that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3109,7 +3118,6 @@ var doc = `{ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/widget.updateWidgetRequest" } }, @@ -3125,31 +3133,31 @@ var doc = `{ "200": { "description": "Widget that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3181,31 +3189,31 @@ var doc = `{ "200": { "description": "Widget that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3213,11 +3221,70 @@ var doc = `{ } }, "definitions": { + "api.ResponseAuthenticate": { + "type": "object" + }, + "api.ResponseConfig": { + "type": "object" + }, + "api.ResponseConfigs": { + "type": "object" + }, + "api.ResponseDashboard": { + "type": "object" + }, + "api.ResponseDashboards": { + "type": "object" + }, + "api.ResponseError": { + "type": "object" + }, + "api.ResponseFile": { + "type": "object" + }, + "api.ResponseFiles": { + "type": "object" + }, + "api.ResponseIC": { + "type": "object" + }, + "api.ResponseICs": { + "type": "object" + }, + "api.ResponseResult": { + "type": "object" + }, + "api.ResponseResults": { + "type": "object" + }, + "api.ResponseScenario": { + "type": "object" + }, + "api.ResponseScenarios": { + "type": "object" + }, + "api.ResponseSignal": { + "type": "object" + }, + "api.ResponseSignals": { + "type": "object" + }, + "api.ResponseUser": { + "type": "object" + }, + "api.ResponseUsers": { + "type": "object" + }, + "api.ResponseWidget": { + "type": "object" + }, + "api.ResponseWidgets": { + "type": "object" + }, "component_configuration.addConfigRequest": { "type": "object", "properties": { "config": { - "type": "object", "$ref": "#/definitions/component_configuration.validNewConfig" } } @@ -3226,7 +3293,6 @@ var doc = `{ "type": "object", "properties": { "config": { - "type": "object", "$ref": "#/definitions/component_configuration.validUpdatedConfig" } } @@ -3256,7 +3322,7 @@ var doc = `{ "type": "integer" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -3276,7 +3342,7 @@ var doc = `{ "type": "string" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -3284,7 +3350,6 @@ var doc = `{ "type": "object", "properties": { "dashboard": { - "type": "object", "$ref": "#/definitions/dashboard.validNewDashboard" } } @@ -3293,7 +3358,6 @@ var doc = `{ "type": "object", "properties": { "dashboard": { - "type": "object", "$ref": "#/definitions/dashboard.validUpdatedDashboard" } } @@ -3334,590 +3398,10 @@ var doc = `{ } } }, - "database.ComponentConfiguration": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "fileIDs": { - "description": "Array of file IDs used by the component configuration", - "type": "string" - }, - "icID": { - "description": "ID of IC associated with Component Configuration", - "type": "integer" - }, - "id": { - "type": "integer" - }, - "inputLength": { - "description": "Number of input signals", - "type": "integer" - }, - "name": { - "description": "Name of Component Configuration", - "type": "string" - }, - "outputLength": { - "description": "Number of output signals", - "type": "integer" - }, - "scenarioID": { - "description": "ID of Scenario to which Component Configuration belongs", - "type": "integer" - }, - "startParameters": { - "description": "Start parameters of Component Configuration as JSON", - "type": "string" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Dashboard": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "grid": { - "description": "Grid of dashboard", - "type": "integer" - }, - "height": { - "description": "Height 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" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.File": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "date": { - "description": "Last modification time of file", - "type": "string" - }, - "id": { - "type": "integer" - }, - "imageHeight": { - "description": "Height of an image file in pixels (optional)", - "type": "integer" - }, - "imageWidth": { - "description": "Width of an image file in pixels (optional)", - "type": "integer" - }, - "name": { - "description": "Name of file", - "type": "string" - }, - "scenarioID": { - "description": "ID of Scenario to which file belongs", - "type": "integer" - }, - "size": { - "description": "Size of file (in byte)", - "type": "integer" - }, - "type": { - "description": "Type of file (MIME type)", - "type": "string" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.InfrastructureComponent": { - "type": "object", - "properties": { - "apiurl": { - "description": "API URL of API for IC", - "type": "string" - }, - "category": { - "description": "Category of IC (simulator, gateway, database, etc.)", - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "description": { - "description": "Description of the IC", - "type": "string" - }, - "id": { - "type": "integer" - }, - "location": { - "description": "Location of the IC", - "type": "string" - }, - "managedexternally": { - "description": "Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller)", - "type": "boolean" - }, - "name": { - "description": "Name of the IC", - "type": "string" - }, - "startparameterscheme": { - "description": "JSON scheme of start parameters for IC", - "type": "string" - }, - "state": { - "description": "State of the IC", - "type": "string" - }, - "stateUpdateAt": { - "description": "Time of last state update", - "type": "string" - }, - "type": { - "description": "Type of IC (RTDS, VILLASnode, RTDS, etc.)", - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "uptime": { - "description": "Uptime of the IC", - "type": "number" - }, - "uuid": { - "description": "UUID of the IC", - "type": "string" - }, - "websocketurl": { - "description": "WebsocketURL if the IC", - "type": "string" - } - } - }, - "database.Result": { - "type": "object", - "properties": { - "configSnapshots": { - "description": "JSON snapshots of component configurations used to generate results", - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "description": { - "description": "Description of results", - "type": "string" - }, - "id": { - "type": "integer" - }, - "resultFileIDs": { - "description": "File IDs associated with result", - "type": "string" - }, - "scenarioID": { - "description": "ID of Scenario to which result belongs", - "type": "integer" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Scenario": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "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" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Signal": { - "type": "object", - "properties": { - "configID": { - "description": "ID of Component Configuration", - "type": "integer" - }, - "createdAt": { - "type": "string" - }, - "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" - }, - "scalingFactor": { - "description": "Scaling factor for the signal raw value (defaults to 1.0)", - "type": "number" - }, - "unit": { - "description": "Unit of Signal", - "type": "string" - }, - "updatedAt": { - "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" - }, - "createdAt": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "mail": { - "description": "Mail of user", - "type": "string" - }, - "role": { - "description": "Role of user", - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "username": { - "description": "Username of user", - "type": "string" - } - } - }, - "database.Widget": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "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" - }, - "signalIDs": { - "description": "IDs of signals that widget uses", - "type": "string" - }, - "type": { - "description": "Type of widget", - "type": "string" - }, - "updatedAt": { - "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.ResponseConfig": { - "type": "object", - "properties": { - "config": { - "type": "object", - "$ref": "#/definitions/database.ComponentConfiguration" - } - } - }, - "docs.ResponseConfigs": { - "type": "object", - "properties": { - "configs": { - "type": "array", - "items": { - "$ref": "#/definitions/database.ComponentConfiguration" - } - } - } - }, - "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.ResponseIC": { - "type": "object", - "properties": { - "ic": { - "type": "object", - "$ref": "#/definitions/database.InfrastructureComponent" - } - } - }, - "docs.ResponseICs": { - "type": "object", - "properties": { - "ics": { - "type": "array", - "items": { - "$ref": "#/definitions/database.InfrastructureComponent" - } - } - } - }, - "docs.ResponseResult": { - "type": "object", - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/database.Result" - } - } - }, - "docs.ResponseResults": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/database.Result" - } - } - } - }, - "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.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" - } - } - } - }, "infrastructure_component.AddICRequest": { "type": "object", "properties": { "ic": { - "type": "object", "$ref": "#/definitions/infrastructure_component.validNewIC" } } @@ -3926,7 +3410,6 @@ var doc = `{ "type": "object", "properties": { "ic": { - "type": "object", "$ref": "#/definitions/infrastructure_component.validUpdatedIC" } } @@ -3959,11 +3442,14 @@ var doc = `{ "type": "string" }, "StartParameterScheme": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "State": { "type": "string" }, + "StatusUpdateRaw": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Type": { "type": "string" }, @@ -3997,11 +3483,14 @@ var doc = `{ "type": "string" }, "StartParameterScheme": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "State": { "type": "string" }, + "StatusUpdateRaw": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Type": { "type": "string" }, @@ -4016,11 +3505,21 @@ var doc = `{ } } }, + "postgres.Jsonb": { + "type": "object", + "properties": { + "json.RawMessage": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, "result.addResultRequest": { "type": "object", "properties": { "result": { - "type": "object", "$ref": "#/definitions/result.validNewResult" } } @@ -4029,7 +3528,6 @@ var doc = `{ "type": "object", "properties": { "result": { - "type": "object", "$ref": "#/definitions/result.validUpdatedResult" } } @@ -4042,7 +3540,7 @@ var doc = `{ ], "properties": { "ConfigSnapshots": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "Description": { "type": "string" @@ -4062,7 +3560,7 @@ var doc = `{ "type": "object", "properties": { "configSnapshots": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "description": { "type": "string" @@ -4079,7 +3577,6 @@ var doc = `{ "type": "object", "properties": { "scenario": { - "type": "object", "$ref": "#/definitions/scenario.validNewScenario" } } @@ -4088,7 +3585,6 @@ var doc = `{ "type": "object", "properties": { "scenario": { - "type": "object", "$ref": "#/definitions/scenario.validUpdatedScenario" } } @@ -4107,7 +3603,7 @@ var doc = `{ "type": "boolean" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -4121,7 +3617,7 @@ var doc = `{ "type": "boolean" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -4129,7 +3625,6 @@ var doc = `{ "type": "object", "properties": { "signal": { - "type": "object", "$ref": "#/definitions/signal.validNewSignal" } } @@ -4138,7 +3633,6 @@ var doc = `{ "type": "object", "properties": { "signal": { - "type": "object", "$ref": "#/definitions/signal.validUpdatedSignal" } } @@ -4193,7 +3687,6 @@ var doc = `{ "type": "object", "properties": { "user": { - "type": "object", "$ref": "#/definitions/user.validNewUser" } } @@ -4217,7 +3710,6 @@ var doc = `{ "type": "object", "properties": { "user": { - "type": "object", "$ref": "#/definitions/user.validUpdatedRequest" } } @@ -4272,7 +3764,6 @@ var doc = `{ "type": "object", "properties": { "widget": { - "type": "object", "$ref": "#/definitions/widget.validNewWidget" } } @@ -4281,7 +3772,6 @@ var doc = `{ "type": "object", "properties": { "widget": { - "type": "object", "$ref": "#/definitions/widget.validUpdatedWidget" } } @@ -4297,7 +3787,7 @@ var doc = `{ ], "properties": { "CustomProperties": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "DashboardID": { "type": "integer" @@ -4344,7 +3834,7 @@ var doc = `{ "type": "object", "properties": { "CustomProperties": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "Height": { "type": "integer" diff --git a/doc/api/swagger.json b/doc/api/swagger.json index 8fdaab0..4790a63 100644 --- a/doc/api/swagger.json +++ b/doc/api/swagger.json @@ -35,7 +35,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.loginRequest" } } @@ -44,19 +43,19 @@ "200": { "description": "JSON web token, success status, message and authenticated user object", "schema": { - "$ref": "#/definitions/docs.ResponseAuthenticate" + "$ref": "#/definitions/api.ResponseAuthenticate" } }, "401": { "description": "Unauthorized", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -90,25 +89,25 @@ "200": { "description": "Component configurations which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseConfigs" + "$ref": "#/definitions/api.ResponseConfigs" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -137,7 +136,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/component_configuration.addConfigRequest" } } @@ -146,31 +144,31 @@ "200": { "description": "Component configuration that was added", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -204,31 +202,31 @@ "200": { "description": "component configuration that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -257,7 +255,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/component_configuration.updateConfigRequest" } }, @@ -273,31 +270,31 @@ "200": { "description": "Component configuration that was added", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -329,31 +326,31 @@ "200": { "description": "component configuration that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseConfig" + "$ref": "#/definitions/api.ResponseConfig" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -387,25 +384,25 @@ "200": { "description": "Dashboards which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseDashboards" + "$ref": "#/definitions/api.ResponseDashboards" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -434,7 +431,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/dashboard.addDashboardRequest" } } @@ -443,31 +439,31 @@ "200": { "description": "Dashboard that was added", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -501,31 +497,31 @@ "200": { "description": "Dashboard that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -554,7 +550,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/dashboard.updateDashboardRequest" } }, @@ -570,31 +565,31 @@ "200": { "description": "Dashboard that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -626,31 +621,31 @@ "200": { "description": "Dashboard that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseDashboard" + "$ref": "#/definitions/api.ResponseDashboard" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -684,25 +679,25 @@ "200": { "description": "Files which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseFiles" + "$ref": "#/definitions/api.ResponseFiles" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -750,31 +745,31 @@ "200": { "description": "File that was added", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -822,31 +817,31 @@ "200": { "description": "File that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -894,31 +889,31 @@ "200": { "description": "File that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -950,31 +945,31 @@ "200": { "description": "File that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseFile" + "$ref": "#/definitions/api.ResponseFile" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -991,13 +986,16 @@ "summary": "Get health status of backend", "operationId": "getHealth", "responses": { - "200": { - "description": "Backend is healthy, database and AMQP broker connections are alive" + "204": { + "description": "Backend is healthy, database and AMQP broker connections are alive", + "schema": { + "type": "string" + } }, "500": { "description": "Backend is NOT healthy", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1022,25 +1020,25 @@ "200": { "description": "ICs requested", "schema": { - "$ref": "#/definitions/docs.ResponseICs" + "$ref": "#/definitions/api.ResponseICs" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1069,7 +1067,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/infrastructure_component.AddICRequest" } } @@ -1078,31 +1075,31 @@ "200": { "description": "Infrastructure Component that was added", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1136,31 +1133,31 @@ "200": { "description": "Infrastructure Component that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1189,7 +1186,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/infrastructure_component.UpdateICRequest" } }, @@ -1205,31 +1201,31 @@ "200": { "description": "Infrastructure Component that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1261,31 +1257,31 @@ "200": { "description": "Infrastructure Component that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseIC" + "$ref": "#/definitions/api.ResponseIC" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1326,31 +1322,31 @@ "200": { "description": "Action sent successfully", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1384,31 +1380,31 @@ "200": { "description": "Configs requested by user", "schema": { - "$ref": "#/definitions/docs.ResponseConfigs" + "$ref": "#/definitions/api.ResponseConfigs" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1426,7 +1422,30 @@ "operationId": "getMetrics", "responses": { "200": { - "description": "Returns Prometheus metrics" + "description": "Returns Prometheus metrics", + "schema": { + "type": "string" + } + } + } + } + }, + "/openapi": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "openapi" + ], + "summary": "Get OpenAPI 2.0 spec of API", + "operationId": "getOpenAPI", + "responses": { + "200": { + "description": "A OpenAPI 2.0 specification of the API", + "schema": { + "type": "string" + } } } } @@ -1459,25 +1478,25 @@ "200": { "description": "Results which belong to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseResults" + "$ref": "#/definitions/api.ResponseResults" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1506,7 +1525,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/result.addResultRequest" } } @@ -1515,31 +1533,31 @@ "200": { "description": "Result that was added", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1573,31 +1591,31 @@ "200": { "description": "Result that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1626,7 +1644,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/result.updateResultRequest" } }, @@ -1642,31 +1659,31 @@ "200": { "description": "Result that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1698,31 +1715,31 @@ "200": { "description": "Result that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1775,31 +1792,31 @@ "200": { "description": "Result that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1840,31 +1857,31 @@ "200": { "description": "Result for which file was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseResult" + "$ref": "#/definitions/api.ResponseResult" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1889,25 +1906,25 @@ "200": { "description": "Scenarios to which user has access", "schema": { - "$ref": "#/definitions/docs.ResponseScenarios" + "$ref": "#/definitions/api.ResponseScenarios" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -1936,7 +1953,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/scenario.addScenarioRequest" } } @@ -1945,31 +1961,31 @@ "200": { "description": "scenario that was added", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2003,25 +2019,25 @@ "200": { "description": "Scenario requested by user", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2050,7 +2066,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/scenario.updateScenarioRequest" } }, @@ -2066,31 +2081,31 @@ "200": { "description": "Updated scenario.", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2122,25 +2137,25 @@ "200": { "description": "Deleted scenario", "schema": { - "$ref": "#/definitions/docs.ResponseScenario" + "$ref": "#/definitions/api.ResponseScenario" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2181,25 +2196,25 @@ "200": { "description": "User that was added to scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2238,25 +2253,25 @@ "200": { "description": "User that was deleted from scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2290,25 +2305,25 @@ "200": { "description": "Array of users that have access to the scenario", "schema": { - "$ref": "#/definitions/docs.ResponseUsers" + "$ref": "#/definitions/api.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2349,25 +2364,25 @@ "200": { "description": "Signals which belong to component configuration", "schema": { - "$ref": "#/definitions/docs.ResponseSignals" + "$ref": "#/definitions/api.ResponseSignals" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2396,7 +2411,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/signal.addSignalRequest" } } @@ -2405,31 +2419,31 @@ "200": { "description": "Signal that was added", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2463,31 +2477,31 @@ "200": { "description": "Signal that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2513,7 +2527,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/signal.updateSignalRequest" } }, @@ -2529,31 +2542,31 @@ "200": { "description": "Signal that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2585,31 +2598,31 @@ "200": { "description": "Signal that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseSignal" + "$ref": "#/definitions/api.ResponseSignal" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2634,25 +2647,25 @@ "200": { "description": "Array of users", "schema": { - "$ref": "#/definitions/docs.ResponseUsers" + "$ref": "#/definitions/api.ResponseUsers" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2681,7 +2694,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.addUserRequest" } } @@ -2690,25 +2702,25 @@ "200": { "description": "Contains added user object", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2742,31 +2754,31 @@ "200": { "description": "requested user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "403": { "description": "Access forbidden.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2795,7 +2807,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/user.updateUserRequest" } }, @@ -2811,37 +2822,37 @@ "200": { "description": "Contains updated user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "400": { "description": "Bad request.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "403": { "description": "Access forbidden.", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2873,25 +2884,25 @@ "200": { "description": "deleted user", "schema": { - "$ref": "#/definitions/docs.ResponseUser" + "$ref": "#/definitions/api.ResponseUser" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2925,25 +2936,25 @@ "200": { "description": "Widgets to which belong to dashboard", "schema": { - "$ref": "#/definitions/docs.ResponseWidgets" + "$ref": "#/definitions/api.ResponseWidgets" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -2972,7 +2983,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/widget.addWidgetRequest" } } @@ -2981,31 +2991,31 @@ "200": { "description": "Widget that was added", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3039,31 +3049,31 @@ "200": { "description": "Widget that was requested", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3092,7 +3102,6 @@ "in": "body", "required": true, "schema": { - "type": "object", "$ref": "#/definitions/widget.updateWidgetRequest" } }, @@ -3108,31 +3117,31 @@ "200": { "description": "Widget that was updated", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3164,31 +3173,31 @@ "200": { "description": "Widget that was deleted", "schema": { - "$ref": "#/definitions/docs.ResponseWidget" + "$ref": "#/definitions/api.ResponseWidget" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "404": { "description": "Not found", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "422": { "description": "Unprocessable entity", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } }, "500": { "description": "Internal server error", "schema": { - "$ref": "#/definitions/docs.ResponseError" + "$ref": "#/definitions/api.ResponseError" } } } @@ -3196,11 +3205,70 @@ } }, "definitions": { + "api.ResponseAuthenticate": { + "type": "object" + }, + "api.ResponseConfig": { + "type": "object" + }, + "api.ResponseConfigs": { + "type": "object" + }, + "api.ResponseDashboard": { + "type": "object" + }, + "api.ResponseDashboards": { + "type": "object" + }, + "api.ResponseError": { + "type": "object" + }, + "api.ResponseFile": { + "type": "object" + }, + "api.ResponseFiles": { + "type": "object" + }, + "api.ResponseIC": { + "type": "object" + }, + "api.ResponseICs": { + "type": "object" + }, + "api.ResponseResult": { + "type": "object" + }, + "api.ResponseResults": { + "type": "object" + }, + "api.ResponseScenario": { + "type": "object" + }, + "api.ResponseScenarios": { + "type": "object" + }, + "api.ResponseSignal": { + "type": "object" + }, + "api.ResponseSignals": { + "type": "object" + }, + "api.ResponseUser": { + "type": "object" + }, + "api.ResponseUsers": { + "type": "object" + }, + "api.ResponseWidget": { + "type": "object" + }, + "api.ResponseWidgets": { + "type": "object" + }, "component_configuration.addConfigRequest": { "type": "object", "properties": { "config": { - "type": "object", "$ref": "#/definitions/component_configuration.validNewConfig" } } @@ -3209,7 +3277,6 @@ "type": "object", "properties": { "config": { - "type": "object", "$ref": "#/definitions/component_configuration.validUpdatedConfig" } } @@ -3239,7 +3306,7 @@ "type": "integer" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -3259,7 +3326,7 @@ "type": "string" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -3267,7 +3334,6 @@ "type": "object", "properties": { "dashboard": { - "type": "object", "$ref": "#/definitions/dashboard.validNewDashboard" } } @@ -3276,7 +3342,6 @@ "type": "object", "properties": { "dashboard": { - "type": "object", "$ref": "#/definitions/dashboard.validUpdatedDashboard" } } @@ -3317,590 +3382,10 @@ } } }, - "database.ComponentConfiguration": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "fileIDs": { - "description": "Array of file IDs used by the component configuration", - "type": "string" - }, - "icID": { - "description": "ID of IC associated with Component Configuration", - "type": "integer" - }, - "id": { - "type": "integer" - }, - "inputLength": { - "description": "Number of input signals", - "type": "integer" - }, - "name": { - "description": "Name of Component Configuration", - "type": "string" - }, - "outputLength": { - "description": "Number of output signals", - "type": "integer" - }, - "scenarioID": { - "description": "ID of Scenario to which Component Configuration belongs", - "type": "integer" - }, - "startParameters": { - "description": "Start parameters of Component Configuration as JSON", - "type": "string" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Dashboard": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "grid": { - "description": "Grid of dashboard", - "type": "integer" - }, - "height": { - "description": "Height 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" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.File": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "date": { - "description": "Last modification time of file", - "type": "string" - }, - "id": { - "type": "integer" - }, - "imageHeight": { - "description": "Height of an image file in pixels (optional)", - "type": "integer" - }, - "imageWidth": { - "description": "Width of an image file in pixels (optional)", - "type": "integer" - }, - "name": { - "description": "Name of file", - "type": "string" - }, - "scenarioID": { - "description": "ID of Scenario to which file belongs", - "type": "integer" - }, - "size": { - "description": "Size of file (in byte)", - "type": "integer" - }, - "type": { - "description": "Type of file (MIME type)", - "type": "string" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.InfrastructureComponent": { - "type": "object", - "properties": { - "apiurl": { - "description": "API URL of API for IC", - "type": "string" - }, - "category": { - "description": "Category of IC (simulator, gateway, database, etc.)", - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "description": { - "description": "Description of the IC", - "type": "string" - }, - "id": { - "type": "integer" - }, - "location": { - "description": "Location of the IC", - "type": "string" - }, - "managedexternally": { - "description": "Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller)", - "type": "boolean" - }, - "name": { - "description": "Name of the IC", - "type": "string" - }, - "startparameterscheme": { - "description": "JSON scheme of start parameters for IC", - "type": "string" - }, - "state": { - "description": "State of the IC", - "type": "string" - }, - "stateUpdateAt": { - "description": "Time of last state update", - "type": "string" - }, - "type": { - "description": "Type of IC (RTDS, VILLASnode, RTDS, etc.)", - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "uptime": { - "description": "Uptime of the IC", - "type": "number" - }, - "uuid": { - "description": "UUID of the IC", - "type": "string" - }, - "websocketurl": { - "description": "WebsocketURL if the IC", - "type": "string" - } - } - }, - "database.Result": { - "type": "object", - "properties": { - "configSnapshots": { - "description": "JSON snapshots of component configurations used to generate results", - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "description": { - "description": "Description of results", - "type": "string" - }, - "id": { - "type": "integer" - }, - "resultFileIDs": { - "description": "File IDs associated with result", - "type": "string" - }, - "scenarioID": { - "description": "ID of Scenario to which result belongs", - "type": "integer" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Scenario": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "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" - }, - "updatedAt": { - "type": "string" - } - } - }, - "database.Signal": { - "type": "object", - "properties": { - "configID": { - "description": "ID of Component Configuration", - "type": "integer" - }, - "createdAt": { - "type": "string" - }, - "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" - }, - "scalingFactor": { - "description": "Scaling factor for the signal raw value (defaults to 1.0)", - "type": "number" - }, - "unit": { - "description": "Unit of Signal", - "type": "string" - }, - "updatedAt": { - "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" - }, - "createdAt": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "mail": { - "description": "Mail of user", - "type": "string" - }, - "role": { - "description": "Role of user", - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "username": { - "description": "Username of user", - "type": "string" - } - } - }, - "database.Widget": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "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" - }, - "signalIDs": { - "description": "IDs of signals that widget uses", - "type": "string" - }, - "type": { - "description": "Type of widget", - "type": "string" - }, - "updatedAt": { - "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.ResponseConfig": { - "type": "object", - "properties": { - "config": { - "type": "object", - "$ref": "#/definitions/database.ComponentConfiguration" - } - } - }, - "docs.ResponseConfigs": { - "type": "object", - "properties": { - "configs": { - "type": "array", - "items": { - "$ref": "#/definitions/database.ComponentConfiguration" - } - } - } - }, - "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.ResponseIC": { - "type": "object", - "properties": { - "ic": { - "type": "object", - "$ref": "#/definitions/database.InfrastructureComponent" - } - } - }, - "docs.ResponseICs": { - "type": "object", - "properties": { - "ics": { - "type": "array", - "items": { - "$ref": "#/definitions/database.InfrastructureComponent" - } - } - } - }, - "docs.ResponseResult": { - "type": "object", - "properties": { - "result": { - "type": "object", - "$ref": "#/definitions/database.Result" - } - } - }, - "docs.ResponseResults": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/database.Result" - } - } - } - }, - "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.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" - } - } - } - }, "infrastructure_component.AddICRequest": { "type": "object", "properties": { "ic": { - "type": "object", "$ref": "#/definitions/infrastructure_component.validNewIC" } } @@ -3909,7 +3394,6 @@ "type": "object", "properties": { "ic": { - "type": "object", "$ref": "#/definitions/infrastructure_component.validUpdatedIC" } } @@ -3942,11 +3426,14 @@ "type": "string" }, "StartParameterScheme": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "State": { "type": "string" }, + "StatusUpdateRaw": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Type": { "type": "string" }, @@ -3980,11 +3467,14 @@ "type": "string" }, "StartParameterScheme": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "State": { "type": "string" }, + "StatusUpdateRaw": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Type": { "type": "string" }, @@ -3999,11 +3489,21 @@ } } }, + "postgres.Jsonb": { + "type": "object", + "properties": { + "json.RawMessage": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, "result.addResultRequest": { "type": "object", "properties": { "result": { - "type": "object", "$ref": "#/definitions/result.validNewResult" } } @@ -4012,7 +3512,6 @@ "type": "object", "properties": { "result": { - "type": "object", "$ref": "#/definitions/result.validUpdatedResult" } } @@ -4025,7 +3524,7 @@ ], "properties": { "ConfigSnapshots": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "Description": { "type": "string" @@ -4045,7 +3544,7 @@ "type": "object", "properties": { "configSnapshots": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "description": { "type": "string" @@ -4062,7 +3561,6 @@ "type": "object", "properties": { "scenario": { - "type": "object", "$ref": "#/definitions/scenario.validNewScenario" } } @@ -4071,7 +3569,6 @@ "type": "object", "properties": { "scenario": { - "type": "object", "$ref": "#/definitions/scenario.validUpdatedScenario" } } @@ -4090,7 +3587,7 @@ "type": "boolean" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -4104,7 +3601,7 @@ "type": "boolean" }, "StartParameters": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" } } }, @@ -4112,7 +3609,6 @@ "type": "object", "properties": { "signal": { - "type": "object", "$ref": "#/definitions/signal.validNewSignal" } } @@ -4121,7 +3617,6 @@ "type": "object", "properties": { "signal": { - "type": "object", "$ref": "#/definitions/signal.validUpdatedSignal" } } @@ -4176,7 +3671,6 @@ "type": "object", "properties": { "user": { - "type": "object", "$ref": "#/definitions/user.validNewUser" } } @@ -4200,7 +3694,6 @@ "type": "object", "properties": { "user": { - "type": "object", "$ref": "#/definitions/user.validUpdatedRequest" } } @@ -4255,7 +3748,6 @@ "type": "object", "properties": { "widget": { - "type": "object", "$ref": "#/definitions/widget.validNewWidget" } } @@ -4264,7 +3756,6 @@ "type": "object", "properties": { "widget": { - "type": "object", "$ref": "#/definitions/widget.validUpdatedWidget" } } @@ -4280,7 +3771,7 @@ ], "properties": { "CustomProperties": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "DashboardID": { "type": "integer" @@ -4327,7 +3818,7 @@ "type": "object", "properties": { "CustomProperties": { - "type": "string" + "$ref": "#/definitions/postgres.Jsonb" }, "Height": { "type": "integer" diff --git a/doc/api/swagger.yaml b/doc/api/swagger.yaml index a863489..9e6697d 100644 --- a/doc/api/swagger.yaml +++ b/doc/api/swagger.yaml @@ -1,16 +1,54 @@ basePath: /api/v2 definitions: + api.ResponseAuthenticate: + type: object + api.ResponseConfig: + type: object + api.ResponseConfigs: + type: object + api.ResponseDashboard: + type: object + api.ResponseDashboards: + type: object + api.ResponseError: + type: object + api.ResponseFile: + type: object + api.ResponseFiles: + type: object + api.ResponseIC: + type: object + api.ResponseICs: + type: object + api.ResponseResult: + type: object + api.ResponseResults: + type: object + api.ResponseScenario: + type: object + api.ResponseScenarios: + type: object + api.ResponseSignal: + type: object + api.ResponseSignals: + type: object + api.ResponseUser: + type: object + api.ResponseUsers: + type: object + api.ResponseWidget: + type: object + api.ResponseWidgets: + type: object component_configuration.addConfigRequest: properties: config: $ref: '#/definitions/component_configuration.validNewConfig' - type: object type: object component_configuration.updateConfigRequest: properties: config: $ref: '#/definitions/component_configuration.validUpdatedConfig' - type: object type: object component_configuration.validNewConfig: properties: @@ -25,7 +63,7 @@ definitions: ScenarioID: type: integer StartParameters: - type: string + $ref: '#/definitions/postgres.Jsonb' required: - ICID - Name @@ -43,19 +81,17 @@ definitions: Name: type: string StartParameters: - type: string + $ref: '#/definitions/postgres.Jsonb' type: object dashboard.addDashboardRequest: properties: dashboard: $ref: '#/definitions/dashboard.validNewDashboard' - type: object type: object dashboard.updateDashboardRequest: properties: dashboard: $ref: '#/definitions/dashboard.validUpdatedDashboard' - type: object type: object dashboard.validNewDashboard: properties: @@ -81,418 +117,15 @@ definitions: name: type: string type: object - database.ComponentConfiguration: - properties: - createdAt: - type: string - fileIDs: - description: Array of file IDs used by the component configuration - type: string - icID: - description: ID of IC associated with Component Configuration - type: integer - id: - type: integer - inputLength: - description: Number of input signals - type: integer - name: - description: Name of Component Configuration - type: string - outputLength: - description: Number of output signals - type: integer - scenarioID: - description: ID of Scenario to which Component Configuration belongs - type: integer - startParameters: - description: Start parameters of Component Configuration as JSON - type: string - updatedAt: - type: string - type: object - database.Dashboard: - properties: - createdAt: - type: string - grid: - description: Grid of dashboard - type: integer - height: - description: Height 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 - updatedAt: - type: string - type: object - database.File: - properties: - createdAt: - type: string - date: - description: Last modification time of file - type: string - id: - type: integer - imageHeight: - description: Height of an image file in pixels (optional) - type: integer - imageWidth: - description: Width of an image file in pixels (optional) - type: integer - name: - description: Name of file - type: string - scenarioID: - description: ID of Scenario to which file belongs - type: integer - size: - description: Size of file (in byte) - type: integer - type: - description: Type of file (MIME type) - type: string - updatedAt: - type: string - type: object - database.InfrastructureComponent: - properties: - apiurl: - description: API URL of API for IC - type: string - category: - description: Category of IC (simulator, gateway, database, etc.) - type: string - createdAt: - type: string - description: - description: Description of the IC - type: string - id: - type: integer - location: - description: Location of the IC - type: string - managedexternally: - description: Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller) - type: boolean - name: - description: Name of the IC - type: string - startparameterscheme: - description: JSON scheme of start parameters for IC - type: string - state: - description: State of the IC - type: string - stateUpdateAt: - description: Time of last state update - type: string - type: - description: Type of IC (RTDS, VILLASnode, RTDS, etc.) - type: string - updatedAt: - type: string - uptime: - description: Uptime of the IC - type: number - uuid: - description: UUID of the IC - type: string - websocketurl: - description: WebsocketURL if the IC - type: string - type: object - database.Result: - properties: - configSnapshots: - description: JSON snapshots of component configurations used to generate results - type: string - createdAt: - type: string - description: - description: Description of results - type: string - id: - type: integer - resultFileIDs: - description: File IDs associated with result - type: string - scenarioID: - description: ID of Scenario to which result belongs - type: integer - updatedAt: - type: string - type: object - database.Scenario: - properties: - createdAt: - type: string - 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 - updatedAt: - type: string - type: object - database.Signal: - properties: - configID: - description: ID of Component Configuration - type: integer - createdAt: - type: string - 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 - scalingFactor: - description: Scaling factor for the signal raw value (defaults to 1.0) - type: number - unit: - description: Unit of Signal - type: string - updatedAt: - type: string - type: object - database.User: - properties: - active: - description: Indicating status of user (false means user is inactive and should - not be able to login) - type: boolean - createdAt: - type: string - id: - type: integer - mail: - description: Mail of user - type: string - role: - description: Role of user - type: string - updatedAt: - type: string - username: - description: Username of user - type: string - type: object - database.Widget: - properties: - createdAt: - type: string - 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 - signalIDs: - description: IDs of signals that widget uses - type: string - type: - description: Type of widget - type: string - updatedAt: - 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 - type: object - docs.ResponseAuthenticate: - properties: - message: - type: string - success: - type: boolean - token: - type: string - user: - $ref: '#/definitions/database.User' - type: object - type: object - docs.ResponseConfig: - properties: - config: - $ref: '#/definitions/database.ComponentConfiguration' - type: object - type: object - docs.ResponseConfigs: - properties: - configs: - items: - $ref: '#/definitions/database.ComponentConfiguration' - type: array - type: object - docs.ResponseDashboard: - properties: - dashboard: - $ref: '#/definitions/database.Dashboard' - type: object - type: object - docs.ResponseDashboards: - properties: - dashboards: - items: - $ref: '#/definitions/database.Dashboard' - type: array - type: object - docs.ResponseError: - properties: - message: - type: string - success: - type: boolean - type: object - docs.ResponseFile: - properties: - file: - $ref: '#/definitions/database.File' - type: object - type: object - docs.ResponseFiles: - properties: - files: - items: - $ref: '#/definitions/database.File' - type: array - type: object - docs.ResponseIC: - properties: - ic: - $ref: '#/definitions/database.InfrastructureComponent' - type: object - type: object - docs.ResponseICs: - properties: - ics: - items: - $ref: '#/definitions/database.InfrastructureComponent' - type: array - type: object - docs.ResponseResult: - properties: - result: - $ref: '#/definitions/database.Result' - type: object - type: object - docs.ResponseResults: - properties: - results: - items: - $ref: '#/definitions/database.Result' - type: array - type: object - docs.ResponseScenario: - properties: - scenario: - $ref: '#/definitions/database.Scenario' - type: object - type: object - docs.ResponseScenarios: - properties: - scenarios: - items: - $ref: '#/definitions/database.Scenario' - type: array - type: object - docs.ResponseSignal: - properties: - signal: - $ref: '#/definitions/database.Signal' - type: object - type: object - docs.ResponseSignals: - properties: - signals: - items: - $ref: '#/definitions/database.Signal' - type: array - type: object - docs.ResponseUser: - properties: - user: - $ref: '#/definitions/database.User' - type: object - type: object - docs.ResponseUsers: - properties: - users: - items: - $ref: '#/definitions/database.User' - type: array - type: object - docs.ResponseWidget: - properties: - widget: - $ref: '#/definitions/database.Widget' - type: object - type: object - docs.ResponseWidgets: - properties: - widgets: - items: - $ref: '#/definitions/database.Widget' - type: array - type: object infrastructure_component.AddICRequest: properties: ic: $ref: '#/definitions/infrastructure_component.validNewIC' - type: object type: object infrastructure_component.UpdateICRequest: properties: ic: $ref: '#/definitions/infrastructure_component.validUpdatedIC' - type: object type: object infrastructure_component.validNewIC: properties: @@ -509,9 +142,11 @@ definitions: Name: type: string StartParameterScheme: - type: string + $ref: '#/definitions/postgres.Jsonb' State: type: string + StatusUpdateRaw: + $ref: '#/definitions/postgres.Jsonb' Type: type: string UUID: @@ -539,9 +174,11 @@ definitions: Name: type: string StartParameterScheme: - type: string + $ref: '#/definitions/postgres.Jsonb' State: type: string + StatusUpdateRaw: + $ref: '#/definitions/postgres.Jsonb' Type: type: string UUID: @@ -551,22 +188,27 @@ definitions: WebsocketURL: type: string type: object + postgres.Jsonb: + properties: + json.RawMessage: + items: + type: integer + type: array + type: object result.addResultRequest: properties: result: $ref: '#/definitions/result.validNewResult' - type: object type: object result.updateResultRequest: properties: result: $ref: '#/definitions/result.validUpdatedResult' - type: object type: object result.validNewResult: properties: ConfigSnapshots: - type: string + $ref: '#/definitions/postgres.Jsonb' Description: type: string ResultFileIDs: @@ -582,7 +224,7 @@ definitions: result.validUpdatedResult: properties: configSnapshots: - type: string + $ref: '#/definitions/postgres.Jsonb' description: type: string resultFileIDs: @@ -594,13 +236,11 @@ definitions: properties: scenario: $ref: '#/definitions/scenario.validNewScenario' - type: object type: object scenario.updateScenarioRequest: properties: scenario: $ref: '#/definitions/scenario.validUpdatedScenario' - type: object type: object scenario.validNewScenario: properties: @@ -609,7 +249,7 @@ definitions: Running: type: boolean StartParameters: - type: string + $ref: '#/definitions/postgres.Jsonb' required: - Name - StartParameters @@ -621,19 +261,17 @@ definitions: Running: type: boolean StartParameters: - type: string + $ref: '#/definitions/postgres.Jsonb' type: object signal.addSignalRequest: properties: signal: $ref: '#/definitions/signal.validNewSignal' - type: object type: object signal.updateSignalRequest: properties: signal: $ref: '#/definitions/signal.validUpdatedSignal' - type: object type: object signal.validNewSignal: properties: @@ -670,7 +308,6 @@ definitions: properties: user: $ref: '#/definitions/user.validNewUser' - type: object type: object user.loginRequest: properties: @@ -686,7 +323,6 @@ definitions: properties: user: $ref: '#/definitions/user.validUpdatedRequest' - type: object type: object user.validNewUser: properties: @@ -723,18 +359,16 @@ definitions: properties: widget: $ref: '#/definitions/widget.validNewWidget' - type: object type: object widget.updateWidgetRequest: properties: widget: $ref: '#/definitions/widget.validUpdatedWidget' - type: object type: object widget.validNewWidget: properties: CustomProperties: - type: string + $ref: '#/definitions/postgres.Jsonb' DashboardID: type: integer Height: @@ -771,7 +405,7 @@ definitions: widget.validUpdatedWidget: properties: CustomProperties: - type: string + $ref: '#/definitions/postgres.Jsonb' Height: type: integer IsLocked: @@ -823,23 +457,21 @@ paths: required: true schema: $ref: '#/definitions/user.loginRequest' - type: object produces: - application/json responses: "200": - description: JSON web token, success status, message and authenticated user - object + description: JSON web token, success status, message and authenticated user object schema: - $ref: '#/definitions/docs.ResponseAuthenticate' + $ref: '#/definitions/api.ResponseAuthenticate' "401": description: Unauthorized schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error. schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' summary: Authentication for user tags: - authentication @@ -858,19 +490,19 @@ paths: "200": description: Component configurations which belong to scenario schema: - $ref: '#/definitions/docs.ResponseConfigs' + $ref: '#/definitions/api.ResponseConfigs' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all component configurations of scenario @@ -881,37 +513,35 @@ paths: - application/json operationId: addConfig parameters: - - description: component configuration to be added incl. IDs of scenario and - IC + - description: component configuration to be added incl. IDs of scenario and IC in: body name: inputConfig required: true schema: $ref: '#/definitions/component_configuration.addConfigRequest' - type: object produces: - application/json responses: "200": description: Component configuration that was added schema: - $ref: '#/definitions/docs.ResponseConfig' + $ref: '#/definitions/api.ResponseConfig' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a component configuration to a scenario @@ -932,23 +562,23 @@ paths: "200": description: component configuration that was deleted schema: - $ref: '#/definitions/docs.ResponseConfig' + $ref: '#/definitions/api.ResponseConfig' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a component configuration @@ -968,23 +598,23 @@ paths: "200": description: component configuration that was requested schema: - $ref: '#/definitions/docs.ResponseConfig' + $ref: '#/definitions/api.ResponseConfig' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get a component configuration @@ -1001,7 +631,6 @@ paths: required: true schema: $ref: '#/definitions/component_configuration.updateConfigRequest' - type: object - description: Config ID in: path name: configID @@ -1013,23 +642,23 @@ paths: "200": description: Component configuration that was added schema: - $ref: '#/definitions/docs.ResponseConfig' + $ref: '#/definitions/api.ResponseConfig' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a component configuration @@ -1050,19 +679,19 @@ paths: "200": description: Dashboards which belong to scenario schema: - $ref: '#/definitions/docs.ResponseDashboards' + $ref: '#/definitions/api.ResponseDashboards' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all dashboards of scenario @@ -1079,30 +708,29 @@ paths: required: true schema: $ref: '#/definitions/dashboard.addDashboardRequest' - type: object produces: - application/json responses: "200": description: Dashboard that was added schema: - $ref: '#/definitions/docs.ResponseDashboard' + $ref: '#/definitions/api.ResponseDashboard' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a dashboard to a scenario @@ -1123,23 +751,23 @@ paths: "200": description: Dashboard that was deleted schema: - $ref: '#/definitions/docs.ResponseDashboard' + $ref: '#/definitions/api.ResponseDashboard' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a dashboard @@ -1159,23 +787,23 @@ paths: "200": description: Dashboard that was requested schema: - $ref: '#/definitions/docs.ResponseDashboard' + $ref: '#/definitions/api.ResponseDashboard' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get a dashboard @@ -1192,7 +820,6 @@ paths: required: true schema: $ref: '#/definitions/dashboard.updateDashboardRequest' - type: object - description: Dashboard ID in: path name: dashboardID @@ -1204,23 +831,23 @@ paths: "200": description: Dashboard that was updated schema: - $ref: '#/definitions/docs.ResponseDashboard' + $ref: '#/definitions/api.ResponseDashboard' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a dashboard @@ -1241,19 +868,19 @@ paths: "200": description: Files which belong to scenario schema: - $ref: '#/definitions/docs.ResponseFiles' + $ref: '#/definitions/api.ResponseFiles' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all files of a specific scenario @@ -1286,23 +913,23 @@ paths: "200": description: File that was added schema: - $ref: '#/definitions/docs.ResponseFile' + $ref: '#/definitions/api.ResponseFile' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a file to a specific scenario @@ -1323,23 +950,23 @@ paths: "200": description: File that was deleted schema: - $ref: '#/definitions/docs.ResponseFile' + $ref: '#/definitions/api.ResponseFile' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a file @@ -1373,23 +1000,23 @@ paths: "200": description: File that was requested schema: - $ref: '#/definitions/docs.ResponseFile' + $ref: '#/definitions/api.ResponseFile' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Download a file @@ -1422,23 +1049,23 @@ paths: "200": description: File that was updated schema: - $ref: '#/definitions/docs.ResponseFile' + $ref: '#/definitions/api.ResponseFile' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a file @@ -1450,13 +1077,14 @@ paths: produces: - application/json responses: - "200": - description: Backend is healthy, database and AMQP broker connections are - alive + "204": + description: Backend is healthy, database and AMQP broker connections are alive + schema: + type: string "500": description: Backend is NOT healthy schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' summary: Get health status of backend tags: - healthz @@ -1469,19 +1097,19 @@ paths: "200": description: ICs requested schema: - $ref: '#/definitions/docs.ResponseICs' + $ref: '#/definitions/api.ResponseICs' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all infrastructure components @@ -1498,30 +1126,29 @@ paths: required: true schema: $ref: '#/definitions/infrastructure_component.AddICRequest' - type: object produces: - application/json responses: "200": description: Infrastructure Component that was added schema: - $ref: '#/definitions/docs.ResponseIC' + $ref: '#/definitions/api.ResponseIC' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add an infrastructure component @@ -1542,23 +1169,23 @@ paths: "200": description: Infrastructure Component that was deleted schema: - $ref: '#/definitions/docs.ResponseIC' + $ref: '#/definitions/api.ResponseIC' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete an infrastructure component @@ -1578,23 +1205,23 @@ paths: "200": description: Infrastructure Component that was requested schema: - $ref: '#/definitions/docs.ResponseIC' + $ref: '#/definitions/api.ResponseIC' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get infrastructure component @@ -1611,7 +1238,6 @@ paths: required: true schema: $ref: '#/definitions/infrastructure_component.UpdateICRequest' - type: object - description: InfrastructureComponent ID in: path name: ICID @@ -1623,23 +1249,23 @@ paths: "200": description: Infrastructure Component that was updated schema: - $ref: '#/definitions/docs.ResponseIC' + $ref: '#/definitions/api.ResponseIC' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update an infrastructure component @@ -1665,27 +1291,26 @@ paths: "200": description: Action sent successfully schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] - summary: Send an action to IC (only available if backend server is started with - -amqp parameter) + summary: Send an action to IC (only available if backend server is started with -amqp parameter) tags: - infrastructure-components /ic/{ICID}/configs: @@ -1703,23 +1328,23 @@ paths: "200": description: Configs requested by user schema: - $ref: '#/definitions/docs.ResponseConfigs' + $ref: '#/definitions/api.ResponseConfigs' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all configurations of the infrastructure component @@ -1733,9 +1358,24 @@ paths: responses: "200": description: Returns Prometheus metrics + schema: + type: string summary: Prometheus metrics endpoint tags: - metrics + /openapi: + get: + operationId: getOpenAPI + produces: + - application/json + responses: + "200": + description: A OpenAPI 2.0 specification of the API + schema: + type: string + summary: Get OpenAPI 2.0 spec of API + tags: + - openapi /results: get: operationId: getResults @@ -1751,19 +1391,19 @@ paths: "200": description: Results which belong to scenario schema: - $ref: '#/definitions/docs.ResponseResults' + $ref: '#/definitions/api.ResponseResults' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all results of scenario @@ -1780,30 +1420,29 @@ paths: required: true schema: $ref: '#/definitions/result.addResultRequest' - type: object produces: - application/json responses: "200": description: Result that was added schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a result to a scenario @@ -1824,23 +1463,23 @@ paths: "200": description: Result that was deleted schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a Result incl. all result files @@ -1860,23 +1499,23 @@ paths: "200": description: Result that was requested schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get a Result @@ -1893,7 +1532,6 @@ paths: required: true schema: $ref: '#/definitions/result.updateResultRequest' - type: object - description: Result ID in: path name: resultID @@ -1905,23 +1543,23 @@ paths: "200": description: Result that was updated schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a result @@ -1958,23 +1596,23 @@ paths: "200": description: Result that was updated schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Upload a result file to the DB and associate it with scenario and result @@ -2000,23 +1638,23 @@ paths: "200": description: Result for which file was deleted schema: - $ref: '#/definitions/docs.ResponseResult' + $ref: '#/definitions/api.ResponseResult' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a result file @@ -2031,19 +1669,19 @@ paths: "200": description: Scenarios to which user has access schema: - $ref: '#/definitions/docs.ResponseScenarios' + $ref: '#/definitions/api.ResponseScenarios' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all scenarios of requesting user @@ -2060,30 +1698,29 @@ paths: required: true schema: $ref: '#/definitions/scenario.addScenarioRequest' - type: object produces: - application/json responses: "200": description: scenario that was added schema: - $ref: '#/definitions/docs.ResponseScenario' + $ref: '#/definitions/api.ResponseScenario' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a scenario @@ -2104,19 +1741,19 @@ paths: "200": description: Deleted scenario schema: - $ref: '#/definitions/docs.ResponseScenario' + $ref: '#/definitions/api.ResponseScenario' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a scenario @@ -2136,19 +1773,19 @@ paths: "200": description: Scenario requested by user schema: - $ref: '#/definitions/docs.ResponseScenario' + $ref: '#/definitions/api.ResponseScenario' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get scenario @@ -2165,7 +1802,6 @@ paths: required: true schema: $ref: '#/definitions/scenario.updateScenarioRequest' - type: object - description: Scenario ID in: path name: scenarioID @@ -2177,23 +1813,23 @@ paths: "200": description: Updated scenario. schema: - $ref: '#/definitions/docs.ResponseScenario' + $ref: '#/definitions/api.ResponseScenario' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a scenario @@ -2219,19 +1855,19 @@ paths: "200": description: User that was deleted from scenario schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a user from a scenario @@ -2256,19 +1892,19 @@ paths: "200": description: User that was added to scenario schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a user to a a scenario @@ -2289,19 +1925,19 @@ paths: "200": description: Array of users that have access to the scenario schema: - $ref: '#/definitions/docs.ResponseUsers' + $ref: '#/definitions/api.ResponseUsers' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get users of a scenario @@ -2327,19 +1963,19 @@ paths: "200": description: Signals which belong to component configuration schema: - $ref: '#/definitions/docs.ResponseSignals' + $ref: '#/definitions/api.ResponseSignals' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all signals of one direction @@ -2350,37 +1986,35 @@ paths: - application/json operationId: AddSignal parameters: - - description: A signal to be added to the component configuration incl. direction - and config ID to which signal shall be added + - description: A signal to be added to the component configuration incl. direction and config ID to which signal shall be added in: body name: inputSignal required: true schema: $ref: '#/definitions/signal.addSignalRequest' - type: object produces: - application/json responses: "200": description: Signal that was added schema: - $ref: '#/definitions/docs.ResponseSignal' + $ref: '#/definitions/api.ResponseSignal' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a signal to a signal mapping of a component configuration @@ -2401,23 +2035,23 @@ paths: "200": description: Signal that was deleted schema: - $ref: '#/definitions/docs.ResponseSignal' + $ref: '#/definitions/api.ResponseSignal' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a signal @@ -2437,23 +2071,23 @@ paths: "200": description: Signal that was requested schema: - $ref: '#/definitions/docs.ResponseSignal' + $ref: '#/definitions/api.ResponseSignal' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get a signal @@ -2468,7 +2102,6 @@ paths: required: true schema: $ref: '#/definitions/signal.updateSignalRequest' - type: object - description: ID of signal to be updated in: path name: signalID @@ -2480,23 +2113,23 @@ paths: "200": description: Signal that was updated schema: - $ref: '#/definitions/docs.ResponseSignal' + $ref: '#/definitions/api.ResponseSignal' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a signal @@ -2511,19 +2144,19 @@ paths: "200": description: Array of users schema: - $ref: '#/definitions/docs.ResponseUsers' + $ref: '#/definitions/api.ResponseUsers' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all users @@ -2540,26 +2173,25 @@ paths: required: true schema: $ref: '#/definitions/user.addUserRequest' - type: object produces: - application/json responses: "200": description: Contains added user object schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a user @@ -2580,19 +2212,19 @@ paths: "200": description: deleted user schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a user @@ -2612,23 +2244,23 @@ paths: "200": description: requested user schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "403": description: Access forbidden. schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get user @@ -2639,14 +2271,12 @@ paths: - application/json operationId: UpdateUser parameters: - - description: User to be updated (anything except for ID can be changed, role - can only be change by admin) + - description: User to be updated (anything except for ID can be changed, role can only be change by admin) in: body name: inputUser required: true schema: $ref: '#/definitions/user.updateUserRequest' - type: object - description: User ID in: path name: userID @@ -2658,27 +2288,27 @@ paths: "200": description: Contains updated user schema: - $ref: '#/definitions/docs.ResponseUser' + $ref: '#/definitions/api.ResponseUser' "400": description: Bad request. schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "403": description: Access forbidden. schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a user @@ -2699,19 +2329,19 @@ paths: "200": description: Widgets to which belong to dashboard schema: - $ref: '#/definitions/docs.ResponseWidgets' + $ref: '#/definitions/api.ResponseWidgets' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get all widgets of dashboard @@ -2728,30 +2358,29 @@ paths: required: true schema: $ref: '#/definitions/widget.addWidgetRequest' - type: object produces: - application/json responses: "200": description: Widget that was added schema: - $ref: '#/definitions/docs.ResponseWidget' + $ref: '#/definitions/api.ResponseWidget' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Add a widget to a dashboard @@ -2772,23 +2401,23 @@ paths: "200": description: Widget that was deleted schema: - $ref: '#/definitions/docs.ResponseWidget' + $ref: '#/definitions/api.ResponseWidget' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Delete a widget @@ -2808,23 +2437,23 @@ paths: "200": description: Widget that was requested schema: - $ref: '#/definitions/docs.ResponseWidget' + $ref: '#/definitions/api.ResponseWidget' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Get a widget @@ -2841,7 +2470,6 @@ paths: required: true schema: $ref: '#/definitions/widget.updateWidgetRequest' - type: object - description: Widget ID in: path name: widgetID @@ -2853,23 +2481,23 @@ paths: "200": description: Widget that was updated schema: - $ref: '#/definitions/docs.ResponseWidget' + $ref: '#/definitions/api.ResponseWidget' "400": description: Bad request schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "404": description: Not found schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "422": description: Unprocessable entity schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' "500": description: Internal server error schema: - $ref: '#/definitions/docs.ResponseError' + $ref: '#/definitions/api.ResponseError' security: - Bearer: [] summary: Update a widget diff --git a/go.sum b/go.sum index 2d06f65..bfc3179 100644 --- a/go.sum +++ b/go.sum @@ -203,6 +203,7 @@ github.com/ugorji/go v1.1.4 h1:j4s+tAvLfL3bZyefP2SEWmhBzmuIlH/eqNuPdFPgngw= github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= github.com/urfave/cli v1.22.5 h1:lNq9sAHXK2qfdI8W+GRItjCEkI+2oR4d+MEHy1CKXoU= github.com/urfave/cli v1.22.5/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= +github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M= github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/zpatrick/go-config v0.0.0-20191104215613-50bc2709703f h1:A3xgNrO0Yh+GQJuplpwSdCqT+xcGNPu2gtg+wvHuq8U=