2019-09-10 14:38:00 +02:00
{
"swagger" : "2.0" ,
"info" : {
2020-09-25 16:16:46 +02:00
"description" : "This is the [VILLASweb Backend](https://git.rwth-aachen.de/acs/public/villas/web-backend-go) API v2.0.\nThis documentation is auto-generated based on the API documentation in the code. The tool [swag](https://github.com/swaggo/swag) is used to auto-generate API docs for the [gin-gonic](https://github.com/gin-gonic/gin) framework.\nAuthentication: Use the authenticate endpoint below to obtain a token for your user account, copy the token into to the value field of the dialog showing up for the green Authorize button below and confirm with Done." ,
2019-09-10 14:38:00 +02:00
"title" : "VILLASweb Backend API" ,
"contact" : {
2022-04-05 16:38:25 +02:00
"name" : "Institute for Automation of Complex Power Systems, RWTH Aachen University"
2019-09-10 14:38:00 +02:00
} ,
"license" : {
"name" : "GNU GPL 3.0" ,
"url" : "http://www.gnu.de/documents/gpl-3.0.en.html"
} ,
"version" : "2.0"
} ,
2020-10-20 12:57:38 +02:00
"basePath" : "/api/v2" ,
2019-09-10 14:38:00 +02:00
"paths" : {
"/authenticate" : {
2021-02-05 19:26:15 +01:00
"get" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"authentication"
] ,
"summary" : "Check if user is authenticated and provide details on how the user can authenticate" ,
"operationId" : "authenticated" ,
"responses" : {
"200" : {
"description" : "JSON web token, success status, message and authenticated user object" ,
"schema" : {
"$ref" : "#/definitions/api.ResponseAuthenticate"
}
} ,
"401" : {
"description" : "Unauthorized" ,
"schema" : {
"$ref" : "#/definitions/api.ResponseError"
}
} ,
"500" : {
"description" : "Internal server error." ,
"schema" : {
"$ref" : "#/definitions/api.ResponseError"
}
}
}
}
} ,
"/authenticate/{mechanism}" : {
2019-09-10 14:38:00 +02:00
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"authentication"
] ,
"summary" : "Authentication for user" ,
"operationId" : "authenticate" ,
"parameters" : [
{
"description" : "loginRequest of user" ,
"name" : "inputUser" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/user.loginRequest"
}
2021-02-05 19:26:15 +01:00
} ,
{
"enum" : [
"internal" ,
"external"
] ,
"type" : "string" ,
"description" : "Login mechanism" ,
"name" : "mechanism" ,
"in" : "path" ,
"required" : true
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
"description" : "JSON web token, success status, message and authenticated user object" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseAuthenticate"
2019-09-10 14:38:00 +02:00
}
} ,
"401" : {
"description" : "Unauthorized" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
2019-09-16 09:17:31 +02:00
"500" : {
"description" : "Internal server error." ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2021-02-05 19:26:15 +01:00
"/config" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"config"
] ,
"summary" : "Get config VILLASweb to be used by frontend" ,
"operationId" : "config" ,
"responses" : {
"200" : {
"description" : "The configuration" ,
"schema" : {
"$ref" : "#/definitions/config.Config"
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/configs" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"component-configurations"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get all component configurations of scenario" ,
"operationId" : "getConfigs" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Component configurations which belong to scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfigs"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"component-configurations"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Add a component configuration to a scenario" ,
"operationId" : "addConfig" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "component configuration to be added incl. IDs of scenario and IC" ,
"name" : "inputConfig" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-03-06 15:14:29 +01:00
"$ref" : "#/definitions/component_configuration.addConfigRequest"
2019-09-10 14:38:00 +02:00
}
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Component configuration that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfig"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/configs/{configID}" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"component-configurations"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get a component configuration" ,
"operationId" : "getConfig" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Config ID" ,
"name" : "configID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "component configuration that was requested" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfig"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"component-configurations"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Update a component configuration" ,
"operationId" : "updateConfig" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "component configuration to be updated" ,
"name" : "inputConfig" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-03-06 15:14:29 +01:00
"$ref" : "#/definitions/component_configuration.updateConfigRequest"
2019-09-10 14:38:00 +02:00
}
} ,
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Config ID" ,
"name" : "configID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Component configuration that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfig"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"component-configurations"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Delete a component configuration" ,
"operationId" : "deleteConfig" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Config ID" ,
"name" : "configID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "component configuration that was deleted" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfig"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/dashboards" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"dashboards"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get all dashboards of scenario" ,
"operationId" : "getDashboards" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2019-09-10 14:38:00 +02:00
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Dashboards which belong to scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseDashboards"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
2020-03-06 15:14:29 +01:00
"application/json"
2019-09-10 14:38:00 +02:00
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"dashboards"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Add a dashboard to a scenario" ,
"operationId" : "addDashboard" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "Dashboard to be added incl. ID of Scenario" ,
"name" : "inputDab" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/dashboard.addDashboardRequest"
}
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Dashboard that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseDashboard"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/dashboards/{dashboardID}" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
2020-03-06 15:14:29 +01:00
"application/json"
2019-09-10 14:38:00 +02:00
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"dashboards"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get a dashboard" ,
"operationId" : "getDashboard" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Dashboard ID" ,
"name" : "dashboardID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Dashboard that was requested" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseDashboard"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
2020-03-06 15:14:29 +01:00
"application/json"
2019-09-10 14:38:00 +02:00
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"dashboards"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Update a dashboard" ,
"operationId" : "updateDashboard" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "Dashboard to be updated" ,
"name" : "inputDab" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/dashboard.updateDashboardRequest"
}
2019-09-10 14:38:00 +02:00
} ,
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Dashboard ID" ,
"name" : "dashboardID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Dashboard that was updated" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseDashboard"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"dashboards"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Delete a dashboard" ,
"operationId" : "deleteDashboard" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Dashboard ID" ,
"name" : "dashboardID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Dashboard that was deleted" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseDashboard"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/files" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"files"
2019-09-10 14:38:00 +02:00
] ,
2020-05-26 11:27:00 +02:00
"summary" : "Get all files of a specific scenario" ,
2020-03-06 15:14:29 +01:00
"operationId" : "getFiles" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
2020-03-06 15:14:29 +01:00
{
"type" : "integer" ,
2020-05-26 11:27:00 +02:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2020-03-06 15:14:29 +01:00
"in" : "query" ,
"required" : true
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-05-26 11:27:00 +02:00
"description" : "Files which belong to scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseFiles"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
2020-03-06 15:14:29 +01:00
"text/plain" ,
"image/png" ,
"image/jpeg" ,
"image/gif" ,
"model/x-cim" ,
2020-09-25 16:16:46 +02:00
"model/x-cim.zip" ,
"multipart/form-data"
2019-09-10 14:38:00 +02:00
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"files"
2019-09-10 14:38:00 +02:00
] ,
2020-05-26 11:27:00 +02:00
"summary" : "Add a file to a specific scenario" ,
2020-03-06 15:14:29 +01:00
"operationId" : "addFile" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"type" : "file" ,
"description" : "File to be uploaded" ,
"name" : "inputFile" ,
"in" : "formData" ,
"required" : true
} ,
{
"type" : "integer" ,
2020-05-26 11:27:00 +02:00
"description" : "ID of scenario to which file shall be added" ,
"name" : "scenarioID" ,
2020-03-06 15:14:29 +01:00
"in" : "query" ,
"required" : true
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "File that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseFile"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/files/{fileID}" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
2020-03-06 15:14:29 +01:00
"text/plain" ,
2021-01-12 17:06:02 +01:00
"text/csv" ,
"application/gzip" ,
"application/x-gtar" ,
"application/x-tar" ,
"application/x-ustar" ,
"application/zip" ,
"application/msexcel" ,
"application/xml" ,
"application/x-bag" ,
2020-03-06 15:14:29 +01:00
"image/png" ,
"image/jpeg" ,
"image/gif" ,
"model/x-cim" ,
"model/x-cim.zip"
2019-09-10 14:38:00 +02:00
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"files"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Download a file" ,
"operationId" : "getFile" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "ID of the file to download" ,
"name" : "fileID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "File that was requested" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseFile"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
2020-03-06 15:14:29 +01:00
"text/plain" ,
"image/png" ,
"image/jpeg" ,
"image/gif" ,
"model/x-cim" ,
2020-09-25 16:16:46 +02:00
"model/x-cim.zip" ,
"multipart/form-data"
2019-09-10 14:38:00 +02:00
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"files"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Update a file" ,
"operationId" : "updateFile" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"type" : "file" ,
"description" : "File to be uploaded" ,
"name" : "inputFile" ,
"in" : "formData" ,
"required" : true
2019-09-10 14:38:00 +02:00
} ,
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "ID of the file to update" ,
"name" : "fileID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "File that was updated" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseFile"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"files"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Delete a file" ,
"operationId" : "deleteFile" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "ID of the file to update" ,
"name" : "fileID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "File that was deleted" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseFile"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/healthz" : {
"get" : {
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"healthz"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get health status of backend" ,
"operationId" : "getHealth" ,
"responses" : {
2021-02-08 11:53:10 +01:00
"204" : {
"description" : "Backend is healthy, database and AMQP broker connections are alive" ,
"schema" : {
"type" : "string"
}
2020-03-06 15:14:29 +01:00
} ,
"500" : {
"description" : "Backend is NOT healthy" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-03-06 15:14:29 +01:00
}
}
}
}
} ,
"/ic" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2020-03-06 15:14:29 +01:00
"produces" : [
"application/json"
] ,
"tags" : [
"infrastructure-components"
] ,
"summary" : "Get all infrastructure components" ,
"operationId" : "getICs" ,
2019-09-10 14:38:00 +02:00
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "ICs requested" ,
2020-03-04 16:34:24 +01:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseICs"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-06 15:14:29 +01:00
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2020-03-06 15:14:29 +01:00
"consumes" : [
"application/json"
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"infrastructure-components"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Add an infrastructure component" ,
"operationId" : "addIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component to be added" ,
"name" : "inputIC" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2020-10-20 12:57:38 +02:00
"$ref" : "#/definitions/infrastructure_component.AddICRequest"
2020-03-06 15:14:29 +01:00
}
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseIC"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/ic/{ICID}" : {
2020-03-04 16:34:24 +01:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2020-03-04 16:34:24 +01:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"infrastructure-components"
2020-03-04 16:34:24 +01:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get infrastructure component" ,
"operationId" : "getIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component ID" ,
"name" : "ICID" ,
"in" : "path" ,
2019-09-10 14:38:00 +02:00
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component that was requested" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseIC"
2020-03-06 15:14:29 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"infrastructure-components"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Update an infrastructure component" ,
"operationId" : "updateIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "InfrastructureComponent to be updated" ,
"name" : "inputIC" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-10-20 12:57:38 +02:00
"$ref" : "#/definitions/infrastructure_component.UpdateICRequest"
2019-09-10 14:38:00 +02:00
}
2020-03-06 15:14:29 +01:00
} ,
{
"type" : "integer" ,
"description" : "InfrastructureComponent ID" ,
"name" : "ICID" ,
"in" : "path" ,
"required" : true
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component that was updated" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseIC"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-06 15:14:29 +01:00
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"infrastructure-components"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Delete an infrastructure component" ,
"operationId" : "deleteIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component ID" ,
"name" : "ICID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component that was deleted" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseIC"
2020-03-04 16:34:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
2020-03-06 15:14:29 +01:00
}
}
}
} ,
"/ic/{ICID}/action" : {
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-11-11 16:34:06 +01:00
"infrastructure-components"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Send an action to IC (only available if backend server is started with -amqp parameter)" ,
"operationId" : "sendActionToIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
2019-11-13 14:48:08 +01:00
{
"type" : "string" ,
2020-03-06 15:14:29 +01:00
"description" : "Action for IC" ,
"name" : "inputAction" ,
"in" : "query" ,
2019-11-13 14:48:08 +01:00
"required" : true
} ,
2019-09-10 14:38:00 +02:00
{
2020-03-04 16:34:24 +01:00
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "InfrastructureComponent ID" ,
"name" : "ICID" ,
2020-03-04 16:34:24 +01:00
"in" : "path" ,
2019-09-10 14:38:00 +02:00
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Action sent successfully" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-03-04 16:34:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-06 15:14:29 +01:00
}
} ,
"/ic/{ICID}/configs" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-06 15:14:29 +01:00
"infrastructure-components"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Get all configurations of the infrastructure component" ,
"operationId" : "getConfigsOfIC" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-06 15:14:29 +01:00
"description" : "Infrastructure Component ID" ,
"name" : "ICID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Configs requested by user" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseConfigs"
2019-09-10 14:38:00 +02:00
}
} ,
2020-03-04 16:34:24 +01:00
"400" : {
"description" : "Bad request" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-06 15:14:29 +01:00
"/metrics" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"metrics"
] ,
"summary" : "Prometheus metrics endpoint" ,
"operationId" : "getMetrics" ,
"responses" : {
"200" : {
2021-02-08 11:53:10 +01:00
"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"
}
2020-03-06 15:14:29 +01:00
}
}
}
} ,
2020-11-19 17:23:24 +01:00
"/results" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Get all results of scenario" ,
"operationId" : "getResults" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Results which belong to scenario" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResults"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Add a result to a scenario" ,
"operationId" : "addResult" ,
"parameters" : [
{
"description" : "Result to be added incl. ID of Scenario" ,
"name" : "inputResult" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/result.addResultRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "Result that was added" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
}
} ,
"/results/{resultID}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Get a Result" ,
"operationId" : "getResult" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Result ID" ,
"name" : "resultID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Result that was requested" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Update a result" ,
"operationId" : "updateResult" ,
"parameters" : [
{
"description" : "Result to be updated" ,
"name" : "inputResult" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/result.updateResultRequest"
}
} ,
{
"type" : "integer" ,
"description" : "Result ID" ,
"name" : "resultID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Result that was updated" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
2021-01-12 17:06:02 +01:00
"summary" : "Delete a Result incl. all result files" ,
2020-11-19 17:23:24 +01:00
"operationId" : "deleteResult" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Result ID" ,
"name" : "resultID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Result that was deleted" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
}
} ,
"/results/{resultID}/file" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"consumes" : [
"text/plain" ,
"text/csv" ,
"application/gzip" ,
"application/x-gtar" ,
"application/x-tar" ,
"application/x-ustar" ,
"application/zip" ,
"application/msexcel" ,
"application/xml" ,
2022-04-14 11:09:04 +02:00
"application/x-bag" ,
"multipart/form-data"
2020-11-19 17:23:24 +01:00
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Upload a result file to the DB and associate it with scenario and result" ,
"operationId" : "addResultFile" ,
"parameters" : [
{
"type" : "file" ,
"description" : "File to be uploaded" ,
"name" : "inputFile" ,
"in" : "formData" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "Result ID" ,
"name" : "resultID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Result that was updated" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
}
} ,
"/results/{resultID}/file/{fileID}" : {
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"results"
] ,
"summary" : "Delete a result file" ,
"operationId" : "deleteResultFile" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Result ID" ,
"name" : "resultID" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "ID of the file to delete" ,
"name" : "fileID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Result for which file was deleted" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseResult"
2020-11-19 17:23:24 +01:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-11-19 17:23:24 +01:00
}
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"/scenarios" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Get all scenarios of requesting user" ,
"operationId" : "getScenarios" ,
2019-09-10 14:38:00 +02:00
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Scenarios to which user has access" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseScenarios"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Add a scenario" ,
"operationId" : "addScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-04 16:34:24 +01:00
"description" : "Scenario to be added" ,
"name" : "inputScenario" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-03-04 16:34:24 +01:00
"$ref" : "#/definitions/scenario.addScenarioRequest"
2019-09-10 14:38:00 +02:00
}
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "scenario that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseScenario"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"/scenarios/{scenarioID}" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Get scenario" ,
"operationId" : "getScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Scenario requested by user" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseScenario"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2020-03-04 16:34:24 +01:00
"consumes" : [
"application/json"
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Update a scenario" ,
"operationId" : "updateScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-04 16:34:24 +01:00
"description" : "Scenario to be updated" ,
"name" : "inputScenario" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-03-04 16:34:24 +01:00
"$ref" : "#/definitions/scenario.updateScenarioRequest"
2019-09-10 14:38:00 +02:00
}
} ,
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Updated scenario." ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseScenario"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Delete a scenario" ,
"operationId" : "deleteScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Deleted scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseScenario"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"/scenarios/{scenarioID}/user" : {
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Add a user to a a scenario" ,
"operationId" : "addUserToScenario" ,
2019-11-13 14:48:08 +01:00
"parameters" : [
2020-03-04 16:34:24 +01:00
{
"type" : "integer" ,
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "User name" ,
"name" : "username" ,
"in" : "query" ,
"required" : true
2019-11-13 14:48:08 +01:00
}
] ,
2019-09-10 14:38:00 +02:00
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "User that was added to scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Delete a user from a scenario" ,
"operationId" : "deleteUserFromScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-04 16:34:24 +01:00
"type" : "integer" ,
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "User name" ,
"name" : "username" ,
"in" : "query" ,
"required" : true
2019-09-10 14:38:00 +02:00
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "User that was deleted from scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"/scenarios/{scenarioID}/users/" : {
2019-09-10 14:38:00 +02:00
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"scenarios"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Get users of a scenario" ,
"operationId" : "getUsersOfScenario" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "Scenario ID" ,
"name" : "scenarioID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Array of users that have access to the scenario" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUsers"
2019-09-10 14:38:00 +02:00
}
} ,
2020-03-04 16:34:24 +01:00
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-03-04 16:34:24 +01:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2020-03-04 16:34:24 +01:00
}
} ,
"500" : {
"description" : "Internal server error" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
2020-03-04 16:34:24 +01:00
}
}
}
} ,
"/signals" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2020-03-04 16:34:24 +01:00
"produces" : [
"application/json"
] ,
"tags" : [
"signals"
] ,
"summary" : "Get all signals of one direction" ,
"operationId" : "getSignals" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Direction of signal (in or out)" ,
"name" : "direction" ,
"in" : "query" ,
"required" : true
} ,
{
"type" : "string" ,
2020-03-06 15:14:29 +01:00
"description" : "Config ID of signals to be obtained" ,
"name" : "configID" ,
2020-03-04 16:34:24 +01:00
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-06 15:14:29 +01:00
"description" : "Signals which belong to component configuration" ,
2020-03-04 16:34:24 +01:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseSignals"
2020-03-04 16:34:24 +01:00
}
2019-09-10 14:38:00 +02:00
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
2020-03-04 16:34:24 +01:00
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"signals"
2019-09-10 14:38:00 +02:00
] ,
2020-03-06 15:14:29 +01:00
"summary" : "Add a signal to a signal mapping of a component configuration" ,
2020-03-04 16:34:24 +01:00
"operationId" : "AddSignal" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
2020-03-06 15:14:29 +01:00
"description" : "A signal to be added to the component configuration incl. direction and config ID to which signal shall be added" ,
2020-03-04 16:34:24 +01:00
"name" : "inputSignal" ,
2019-09-10 14:38:00 +02:00
"in" : "body" ,
"required" : true ,
"schema" : {
2020-03-04 16:34:24 +01:00
"$ref" : "#/definitions/signal.addSignalRequest"
2019-09-10 14:38:00 +02:00
}
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Signal that was added" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseSignal"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-04 16:34:24 +01:00
}
} ,
"/signals/{signalID}" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"signals"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Get a signal" ,
"operationId" : "getSignal" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "ID of signal to be obtained" ,
"name" : "signalID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Signal that was requested" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseSignal"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-04 16:34:24 +01:00
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"signals"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Update a signal" ,
"operationId" : "updateSignal" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
2020-03-04 16:34:24 +01:00
{
"description" : "A signal to be updated" ,
"name" : "inputSignal" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/signal.updateSignalRequest"
}
} ,
2019-09-10 14:38:00 +02:00
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "ID of signal to be updated" ,
"name" : "signalID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Signal that was updated" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseSignal"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
2020-03-04 16:34:24 +01:00
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
2020-03-04 16:34:24 +01:00
"signals"
2019-09-10 14:38:00 +02:00
] ,
2020-03-04 16:34:24 +01:00
"summary" : "Delete a signal" ,
"operationId" : "deleteSignal" ,
2019-09-10 14:38:00 +02:00
"parameters" : [
{
"type" : "integer" ,
2020-03-04 16:34:24 +01:00
"description" : "ID of signal to be deleted" ,
"name" : "signalID" ,
2019-09-10 14:38:00 +02:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2020-03-04 16:34:24 +01:00
"description" : "Signal that was deleted" ,
2019-09-10 14:38:00 +02:00
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseSignal"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
"/users" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"users"
] ,
"summary" : "Get all users" ,
"operationId" : "GetUsers" ,
"responses" : {
"200" : {
"description" : "Array of users" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUsers"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"users"
] ,
"summary" : "Add a user" ,
"operationId" : "AddUser" ,
"parameters" : [
{
"description" : "User to be added" ,
"name" : "inputUser" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2019-11-13 14:48:08 +01:00
"$ref" : "#/definitions/user.addUserRequest"
2019-09-10 14:38:00 +02:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Contains added user object" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
"/users/{userID}" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"users"
] ,
"summary" : "Get user" ,
"operationId" : "GetUser" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "User ID" ,
"name" : "userID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "requested user" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"403" : {
"description" : "Access forbidden." ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"users"
] ,
"summary" : "Update a user" ,
"operationId" : "UpdateUser" ,
"parameters" : [
{
"description" : "User to be updated (anything except for ID can be changed, role can only be change by admin)" ,
"name" : "inputUser" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2019-11-13 14:48:08 +01:00
"$ref" : "#/definitions/user.updateUserRequest"
2019-09-10 14:38:00 +02:00
}
} ,
{
"type" : "integer" ,
"description" : "User ID" ,
"name" : "userID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Contains updated user" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request." ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"403" : {
"description" : "Access forbidden." ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"users"
] ,
"summary" : "Delete a user" ,
"operationId" : "DeleteUser" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "User ID" ,
"name" : "userID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "deleted user" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseUser"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
"/widgets" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"widgets"
] ,
"summary" : "Get all widgets of dashboard" ,
"operationId" : "getWidgets" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Dashboard ID" ,
"name" : "dashboardID" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Widgets to which belong to dashboard" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseWidgets"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"post" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"widgets"
] ,
"summary" : "Add a widget to a dashboard" ,
"operationId" : "addWidget" ,
"parameters" : [
{
"description" : "Widget to be added incl. ID of dashboard" ,
"name" : "inputWidget" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2019-11-13 14:48:08 +01:00
"$ref" : "#/definitions/widget.addWidgetRequest"
2019-09-10 14:38:00 +02:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Widget that was added" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseWidget"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
} ,
"/widgets/{widgetID}" : {
"get" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"widgets"
] ,
"summary" : "Get a widget" ,
"operationId" : "getWidget" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Widget ID" ,
"name" : "widgetID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Widget that was requested" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseWidget"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"put" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"widgets"
] ,
"summary" : "Update a widget" ,
"operationId" : "updateWidget" ,
"parameters" : [
{
"description" : "Widget to be updated" ,
"name" : "inputWidget" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2019-11-13 14:48:08 +01:00
"$ref" : "#/definitions/widget.updateWidgetRequest"
2019-09-10 14:38:00 +02:00
}
} ,
{
"type" : "integer" ,
"description" : "Widget ID" ,
"name" : "widgetID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Widget that was updated" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseWidget"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
} ,
"delete" : {
2020-09-25 16:16:46 +02:00
"security" : [
{
"Bearer" : [ ]
}
] ,
2019-09-10 14:38:00 +02:00
"produces" : [
"application/json"
] ,
"tags" : [
"widgets"
] ,
"summary" : "Delete a widget" ,
"operationId" : "deleteWidget" ,
"parameters" : [
{
"type" : "integer" ,
"description" : "Widget ID" ,
"name" : "widgetID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Widget that was deleted" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseWidget"
2019-09-10 14:38:00 +02:00
}
} ,
"400" : {
"description" : "Bad request" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"404" : {
"description" : "Not found" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"422" : {
"description" : "Unprocessable entity" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
} ,
"500" : {
"description" : "Internal server error" ,
"schema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/api.ResponseError"
2019-09-10 14:38:00 +02:00
}
}
}
}
}
} ,
"definitions" : {
2021-02-08 11:53:10 +01:00
"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"
} ,
2020-03-06 15:14:29 +01:00
"component_configuration.addConfigRequest" : {
"type" : "object" ,
"properties" : {
"config" : {
"$ref" : "#/definitions/component_configuration.validNewConfig"
}
}
} ,
"component_configuration.updateConfigRequest" : {
"type" : "object" ,
"properties" : {
"config" : {
"$ref" : "#/definitions/component_configuration.validUpdatedConfig"
}
}
} ,
"component_configuration.validNewConfig" : {
"type" : "object" ,
"required" : [
"Name" ,
"ScenarioID" ,
"StartParameters"
] ,
"properties" : {
2020-07-06 15:31:51 +02:00
"FileIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
2020-03-06 15:14:29 +01:00
"ICID" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
"ScenarioID" : {
"type" : "integer"
} ,
"StartParameters" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-03-06 15:14:29 +01:00
}
}
} ,
"component_configuration.validUpdatedConfig" : {
"type" : "object" ,
"properties" : {
2020-07-06 15:31:51 +02:00
"FileIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
2020-03-06 15:14:29 +01:00
"ICID" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
"StartParameters" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-03-06 15:14:29 +01:00
}
}
} ,
2022-04-14 11:39:14 +02:00
"config.Authentication" : {
"type" : "object" ,
"properties" : {
"external" : {
"$ref" : "#/definitions/config.AuthenticationExternal"
} ,
"logout_url" : {
"type" : "string"
}
}
} ,
"config.AuthenticationExternal" : {
"type" : "object" ,
"properties" : {
"authorize_url" : {
"type" : "string"
} ,
"enabled" : {
"type" : "boolean"
} ,
"provider_name" : {
"type" : "string"
}
}
} ,
2021-02-05 19:26:15 +01:00
"config.Config" : {
"type" : "object" ,
"properties" : {
2022-04-05 16:38:25 +02:00
"authentication" : {
2022-04-14 11:39:14 +02:00
"$ref" : "#/definitions/config.Authentication"
2022-04-05 16:38:25 +02:00
} ,
"contact" : {
2022-04-14 11:39:14 +02:00
"$ref" : "#/definitions/config.Contact"
2022-04-05 16:38:25 +02:00
} ,
"kubernetes" : {
2022-04-14 11:39:14 +02:00
"$ref" : "#/definitions/config.Kubernetes"
2022-04-05 16:38:25 +02:00
} ,
"mode" : {
"type" : "string"
} ,
"sub_title" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
2022-04-14 11:39:14 +02:00
"webrtc" : {
"$ref" : "#/definitions/config.WebRTC"
2022-04-05 16:38:25 +02:00
}
}
} ,
2022-04-14 11:39:14 +02:00
"config.Contact" : {
2022-04-05 16:38:25 +02:00
"type" : "object" ,
"properties" : {
2022-04-14 11:39:14 +02:00
"mail" : {
2022-04-05 16:38:25 +02:00
"type" : "string"
} ,
2022-04-14 11:39:14 +02:00
"name" : {
2022-04-05 16:38:25 +02:00
"type" : "string"
}
}
} ,
2022-04-20 16:45:33 +02:00
"config.ICEServer" : {
"type" : "object" ,
"properties" : {
"password" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
} ,
"username" : {
"type" : "string"
}
}
} ,
2022-04-14 11:39:14 +02:00
"config.Kubernetes" : {
2022-04-05 16:38:25 +02:00
"type" : "object" ,
"properties" : {
2022-04-14 11:39:14 +02:00
"cluster_name" : {
2022-04-05 16:38:25 +02:00
"type" : "string"
} ,
2022-04-14 11:39:14 +02:00
"rancher_url" : {
2022-04-05 16:38:25 +02:00
"type" : "string"
}
}
} ,
2022-04-14 11:39:14 +02:00
"config.WebRTC" : {
2022-04-05 16:38:25 +02:00
"type" : "object" ,
"properties" : {
2022-04-20 16:45:33 +02:00
"ice_servers" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/config.ICEServer"
}
2022-04-05 16:38:25 +02:00
}
}
2021-02-05 19:26:15 +01:00
} ,
2019-11-13 14:48:08 +01:00
"dashboard.addDashboardRequest" : {
"type" : "object" ,
"properties" : {
"dashboard" : {
"$ref" : "#/definitions/dashboard.validNewDashboard"
}
}
} ,
"dashboard.updateDashboardRequest" : {
"type" : "object" ,
"properties" : {
"dashboard" : {
"$ref" : "#/definitions/dashboard.validUpdatedDashboard"
}
}
} ,
2019-09-16 09:17:31 +02:00
"dashboard.validNewDashboard" : {
"type" : "object" ,
"required" : [
"Grid" ,
"Name" ,
"ScenarioID"
] ,
"properties" : {
"Grid" : {
"type" : "integer"
} ,
2020-06-26 09:44:25 +02:00
"Height" : {
"type" : "integer"
} ,
2019-09-16 09:17:31 +02:00
"Name" : {
"type" : "string"
} ,
"ScenarioID" : {
"type" : "integer"
}
}
} ,
"dashboard.validUpdatedDashboard" : {
"type" : "object" ,
"properties" : {
2019-11-13 14:48:08 +01:00
"grid" : {
2019-09-16 09:17:31 +02:00
"type" : "integer"
} ,
2020-06-26 09:44:25 +02:00
"height" : {
"type" : "integer"
} ,
2019-11-13 14:48:08 +01:00
"name" : {
2019-09-16 09:17:31 +02:00
"type" : "string"
}
}
} ,
2020-10-20 12:57:38 +02:00
"infrastructure_component.AddICRequest" : {
2020-03-04 16:34:24 +01:00
"type" : "object" ,
"properties" : {
"ic" : {
"$ref" : "#/definitions/infrastructure_component.validNewIC"
}
}
} ,
2020-10-20 12:57:38 +02:00
"infrastructure_component.UpdateICRequest" : {
2020-03-04 16:34:24 +01:00
"type" : "object" ,
"properties" : {
"ic" : {
"$ref" : "#/definitions/infrastructure_component.validUpdatedIC"
}
}
} ,
"infrastructure_component.validNewIC" : {
"type" : "object" ,
"required" : [
2020-05-26 11:27:00 +02:00
"Category" ,
2020-11-11 16:34:06 +01:00
"ManagedExternally" ,
2020-05-26 11:27:00 +02:00
"Name" ,
2020-11-11 16:34:06 +01:00
"Type"
2020-03-04 16:34:24 +01:00
] ,
"properties" : {
2020-10-20 12:57:38 +02:00
"APIURL" : {
2020-06-26 10:02:57 +02:00
"type" : "string"
} ,
2020-05-26 11:27:00 +02:00
"Category" : {
"type" : "string"
} ,
2021-08-11 16:58:49 +02:00
"CreateParameterSchema" : {
"$ref" : "#/definitions/postgres.Jsonb"
} ,
2020-10-20 12:57:38 +02:00
"Description" : {
"type" : "string"
} ,
"Location" : {
2020-03-04 16:34:24 +01:00
"type" : "string"
} ,
2020-11-11 16:34:06 +01:00
"ManagedExternally" : {
"type" : "boolean"
} ,
2021-03-08 09:40:22 +01:00
"Manager" : {
"type" : "string"
} ,
2020-05-26 11:27:00 +02:00
"Name" : {
2020-03-04 16:34:24 +01:00
"type" : "string"
} ,
2021-03-08 09:40:22 +01:00
"StartParameterSchema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-03-04 16:34:24 +01:00
} ,
"State" : {
"type" : "string"
} ,
2021-02-08 11:53:10 +01:00
"StatusUpdateRaw" : {
"$ref" : "#/definitions/postgres.Jsonb"
} ,
2020-05-26 11:27:00 +02:00
"Type" : {
"type" : "string"
} ,
2020-03-04 16:34:24 +01:00
"UUID" : {
"type" : "string"
2020-10-20 12:57:38 +02:00
} ,
2020-11-11 16:34:06 +01:00
"Uptime" : {
"type" : "number"
} ,
2020-10-20 12:57:38 +02:00
"WebsocketURL" : {
"type" : "string"
2020-03-04 16:34:24 +01:00
}
}
} ,
"infrastructure_component.validUpdatedIC" : {
"type" : "object" ,
"properties" : {
2020-10-20 12:57:38 +02:00
"APIURL" : {
2020-06-26 10:02:57 +02:00
"type" : "string"
} ,
2020-05-26 11:27:00 +02:00
"Category" : {
"type" : "string"
} ,
2021-08-11 16:58:49 +02:00
"CreateParameterSchema" : {
"$ref" : "#/definitions/postgres.Jsonb"
} ,
2020-10-20 12:57:38 +02:00
"Description" : {
"type" : "string"
} ,
"Location" : {
2020-03-04 16:34:24 +01:00
"type" : "string"
} ,
2021-03-08 09:40:22 +01:00
"Manager" : {
"type" : "string"
} ,
2020-05-26 11:27:00 +02:00
"Name" : {
2020-03-04 16:34:24 +01:00
"type" : "string"
} ,
2021-03-08 09:40:22 +01:00
"StartParameterSchema" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-03-04 16:34:24 +01:00
} ,
"State" : {
"type" : "string"
} ,
2021-02-08 11:53:10 +01:00
"StatusUpdateRaw" : {
"$ref" : "#/definitions/postgres.Jsonb"
} ,
2020-05-26 11:27:00 +02:00
"Type" : {
"type" : "string"
} ,
2020-03-04 16:34:24 +01:00
"UUID" : {
"type" : "string"
2020-10-20 12:57:38 +02:00
} ,
2020-11-11 16:34:06 +01:00
"Uptime" : {
"type" : "number"
} ,
2020-10-20 12:57:38 +02:00
"WebsocketURL" : {
"type" : "string"
2020-03-04 16:34:24 +01:00
}
}
} ,
2021-02-08 11:53:10 +01:00
"postgres.Jsonb" : {
"type" : "object" ,
"properties" : {
"json.RawMessage" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
}
}
} ,
2020-11-19 17:23:24 +01:00
"result.addResultRequest" : {
"type" : "object" ,
"properties" : {
"result" : {
"$ref" : "#/definitions/result.validNewResult"
}
}
} ,
"result.updateResultRequest" : {
"type" : "object" ,
"properties" : {
"result" : {
"$ref" : "#/definitions/result.validUpdatedResult"
}
}
} ,
"result.validNewResult" : {
"type" : "object" ,
"required" : [
"ConfigSnapshots" ,
"ScenarioID"
] ,
"properties" : {
"ConfigSnapshots" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-11-19 17:23:24 +01:00
} ,
"Description" : {
"type" : "string"
} ,
"ResultFileIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"ScenarioID" : {
"type" : "integer"
}
}
} ,
"result.validUpdatedResult" : {
"type" : "object" ,
"properties" : {
"configSnapshots" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2020-11-19 17:23:24 +01:00
} ,
"description" : {
"type" : "string"
} ,
"resultFileIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
}
}
} ,
2019-11-13 14:48:08 +01:00
"scenario.addScenarioRequest" : {
"type" : "object" ,
"properties" : {
"scenario" : {
"$ref" : "#/definitions/scenario.validNewScenario"
}
}
} ,
"scenario.updateScenarioRequest" : {
"type" : "object" ,
"properties" : {
"scenario" : {
"$ref" : "#/definitions/scenario.validUpdatedScenario"
}
}
} ,
2019-09-10 14:38:00 +02:00
"scenario.validNewScenario" : {
"type" : "object" ,
"required" : [
"Name" ,
"StartParameters"
] ,
"properties" : {
"Name" : {
"type" : "string"
} ,
"StartParameters" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2019-09-10 14:38:00 +02:00
}
}
} ,
"scenario.validUpdatedScenario" : {
"type" : "object" ,
"properties" : {
2021-03-25 15:40:51 +01:00
"IsLocked" : {
"type" : "boolean"
} ,
2019-09-10 14:38:00 +02:00
"Name" : {
"type" : "string"
} ,
"StartParameters" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2019-09-10 14:38:00 +02:00
}
}
} ,
2019-11-13 14:48:08 +01:00
"signal.addSignalRequest" : {
"type" : "object" ,
"properties" : {
"signal" : {
"$ref" : "#/definitions/signal.validNewSignal"
}
}
} ,
"signal.updateSignalRequest" : {
"type" : "object" ,
"properties" : {
"signal" : {
"$ref" : "#/definitions/signal.validUpdatedSignal"
}
}
} ,
2019-09-10 14:38:00 +02:00
"signal.validNewSignal" : {
"type" : "object" ,
"required" : [
2020-03-06 15:14:29 +01:00
"ConfigID" ,
2019-09-10 14:38:00 +02:00
"Direction" ,
"Index" ,
2020-03-06 15:14:29 +01:00
"Name"
2019-09-10 14:38:00 +02:00
] ,
"properties" : {
2020-03-06 15:14:29 +01:00
"ConfigID" : {
"type" : "integer"
} ,
2019-09-10 14:38:00 +02:00
"Direction" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"enum" : [
"in" ,
"out"
]
2019-09-10 14:38:00 +02:00
} ,
"Index" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
2020-06-26 10:17:21 +02:00
"ScalingFactor" : {
"type" : "number"
} ,
2019-09-10 14:38:00 +02:00
"Unit" : {
"type" : "string"
}
}
} ,
"signal.validUpdatedSignal" : {
"type" : "object" ,
"properties" : {
"Index" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
2020-06-26 10:17:21 +02:00
"ScalingFactor" : {
"type" : "number"
} ,
2019-09-10 14:38:00 +02:00
"Unit" : {
"type" : "string"
}
}
} ,
2019-11-13 14:48:08 +01:00
"user.addUserRequest" : {
"type" : "object" ,
"properties" : {
"user" : {
"$ref" : "#/definitions/user.validNewUser"
}
}
} ,
2019-09-10 14:38:00 +02:00
"user.loginRequest" : {
"type" : "object" ,
"required" : [
"Password" ,
"Username"
] ,
"properties" : {
"Password" : {
"type" : "string"
} ,
"Username" : {
"type" : "string"
}
}
} ,
2019-11-13 14:48:08 +01:00
"user.updateUserRequest" : {
"type" : "object" ,
"properties" : {
"user" : {
"$ref" : "#/definitions/user.validUpdatedRequest"
}
}
} ,
2019-09-10 14:38:00 +02:00
"user.validNewUser" : {
"type" : "object" ,
"required" : [
"Mail" ,
"Password" ,
"Role" ,
"Username"
] ,
"properties" : {
"Mail" : {
"type" : "string"
} ,
"Password" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"minLength" : 6
2019-09-10 14:38:00 +02:00
} ,
"Role" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"enum" : [
"Admin" ,
"User" ,
"Guest"
]
2019-09-10 14:38:00 +02:00
} ,
"Username" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"minLength" : 3
2019-09-10 14:38:00 +02:00
}
}
} ,
"user.validUpdatedRequest" : {
"type" : "object" ,
"properties" : {
2019-11-13 14:48:08 +01:00
"Active" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"enum" : [
"yes" ,
"no"
]
2019-11-13 14:48:08 +01:00
} ,
2019-09-10 14:38:00 +02:00
"Mail" : {
"type" : "string"
} ,
2019-11-13 14:48:08 +01:00
"OldPassword" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"minLength" : 6
2019-11-13 14:48:08 +01:00
} ,
2019-09-10 14:38:00 +02:00
"Password" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"minLength" : 6
2019-09-10 14:38:00 +02:00
} ,
"Role" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"enum" : [
"Admin" ,
"User" ,
"Guest"
]
2019-09-10 14:38:00 +02:00
} ,
"Username" : {
2022-04-14 11:39:14 +02:00
"type" : "string" ,
"minLength" : 3
2019-09-10 14:38:00 +02:00
}
}
} ,
2019-11-13 14:48:08 +01:00
"widget.addWidgetRequest" : {
"type" : "object" ,
"properties" : {
"widget" : {
"$ref" : "#/definitions/widget.validNewWidget"
}
}
} ,
"widget.updateWidgetRequest" : {
"type" : "object" ,
"properties" : {
"widget" : {
"$ref" : "#/definitions/widget.validUpdatedWidget"
}
}
} ,
2019-09-10 14:38:00 +02:00
"widget.validNewWidget" : {
"type" : "object" ,
"required" : [
"DashboardID" ,
"Height" ,
"Type" ,
"Width"
] ,
"properties" : {
"CustomProperties" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2019-09-10 14:38:00 +02:00
} ,
"DashboardID" : {
"type" : "integer"
} ,
"Height" : {
"type" : "integer"
} ,
"IsLocked" : {
"type" : "boolean"
} ,
"MinHeight" : {
"type" : "integer"
} ,
"MinWidth" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
2020-03-04 16:34:24 +01:00
"SignalIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
2019-09-10 14:38:00 +02:00
"Type" : {
"type" : "string"
} ,
"Width" : {
"type" : "integer"
} ,
"X" : {
"type" : "integer"
} ,
"Y" : {
"type" : "integer"
} ,
"Z" : {
"type" : "integer"
}
}
} ,
"widget.validUpdatedWidget" : {
"type" : "object" ,
"properties" : {
"CustomProperties" : {
2021-02-08 11:53:10 +01:00
"$ref" : "#/definitions/postgres.Jsonb"
2019-09-10 14:38:00 +02:00
} ,
"Height" : {
"type" : "integer"
} ,
"IsLocked" : {
"type" : "boolean"
} ,
"MinHeight" : {
"type" : "integer"
} ,
"MinWidth" : {
"type" : "integer"
} ,
"Name" : {
"type" : "string"
} ,
2020-03-04 16:34:24 +01:00
"SignalIDs" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
2019-09-10 14:38:00 +02:00
"Type" : {
"type" : "string"
} ,
"Width" : {
"type" : "integer"
} ,
"X" : {
"type" : "integer"
} ,
"Y" : {
"type" : "integer"
} ,
"Z" : {
"type" : "integer"
}
}
}
2020-09-25 16:16:46 +02:00
} ,
"securityDefinitions" : {
"Bearer" : {
"type" : "apiKey" ,
"name" : "Authorization" ,
"in" : "header"
}
2019-09-10 14:38:00 +02:00
}
}