{
  "openapi": "3.0.1",
  "info": {
    "title": "Bastian PLC Hub",
    "version": "1.0.2.0"
  },
  "paths": {
    "/Devices": {
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "Devices",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeviceArrayResult"
                }
              }
            }
          }
        }
      }
    },
    "/Devices/config": {
      "get": {
        "tags": [
          "Devices"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DevicesConfigResult"
                }
              }
            }
          }
        }
      }
    },
    "/Devices/{deviceName}": {
      "get": {
        "tags": [
          "Devices"
        ],
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeviceResult"
                }
              }
            }
          }
        }
      }
    },
    "/Devices/{deviceName}/{signalName}": {
      "get": {
        "tags": [
          "Devices"
        ],
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "signalName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignalValueResult"
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Devices"
        ],
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "signalName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "signalValue",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        }
      }
    },
    "/Devices/{deviceName}/{signalName}/overwrite": {
      "put": {
        "tags": [
          "Devices"
        ],
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "signalName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "overwrite",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "overwriteValue",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        }
      }
    },
    "/Signals/config": {
      "get": {
        "tags": [
          "Signals"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlcConfigResult"
                }
              }
            }
          }
        }
      }
    },
    "/Signals/{signalName}": {
      "get": {
        "tags": [
          "Signals"
        ],
        "parameters": [
          {
            "name": "signalName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignalDataResult"
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Signals"
        ],
        "parameters": [
          {
            "name": "signalName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignalValue"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          }
        }
      }
    },
    "/Signals": {
      "get": {
        "tags": [
          "Signals"
        ],
        "operationId": "Signals",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignalDataCollectionResult"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Signals"
        ],
        "operationId": "Signals",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignalDataCollectionResult"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Device": {
        "type": "object",
        "properties": {
          "config": {
            "$ref": "#/components/schemas/DeviceConfig"
          },
          "signalValues": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/SignalValue"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DeviceArrayResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Device"
            },
            "nullable": true,
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "DeviceConfig": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "signals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeviceSignalConfig"
            },
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DeviceResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/Device"
          }
        },
        "additionalProperties": false
      },
      "DeviceSignalConfig": {
        "required": [
          "actualName"
        ],
        "type": "object",
        "properties": {
          "abstractName": {
            "type": "string",
            "nullable": true
          },
          "actualName": {
            "minLength": 1,
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "DevicesConfig": {
        "type": "object",
        "properties": {
          "devices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeviceConfig"
            },
            "nullable": true
          },
          "runLoopDelayMilliseconds": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DevicesConfigResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/DevicesConfig"
          }
        },
        "additionalProperties": false
      },
      "PlcConfig": {
        "type": "object",
        "properties": {
          "plcs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlcConnectionConfig"
            },
            "nullable": true
          },
          "signalsFromPlc": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlcSignalConfig"
            },
            "nullable": true
          },
          "signalsToPlc": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlcSignalConfig"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PlcConfigResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/PlcConfig"
          }
        },
        "additionalProperties": false
      },
      "PlcConnectionConfig": {
        "type": "object",
        "properties": {
          "configGroup": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PlcConnectionStates": {
        "enum": [
          0,
          1,
          2
        ],
        "type": "integer",
        "format": "int32"
      },
      "PlcSignalConfig": {
        "type": "object",
        "properties": {
          "configGroup": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "plcName": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "Result": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "SignalData": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "nullable": true
          },
          "connectionState": {
            "$ref": "#/components/schemas/PlcConnectionStates"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "plcName": {
            "type": "string",
            "nullable": true
          },
          "signalValue": {
            "$ref": "#/components/schemas/SignalValue"
          },
          "type": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SignalDataCollectionResult": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SignalDataNamedResult"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SignalDataNamedResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "result": {
            "$ref": "#/components/schemas/SignalDataResult"
          },
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/SignalData"
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "SignalDataResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/SignalData"
          }
        },
        "additionalProperties": false
      },
      "SignalValue": {
        "type": "object",
        "properties": {
          "overwrite": {
            "type": "boolean"
          },
          "overwriteValue": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SignalValueResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "isFailure": {
            "type": "boolean",
            "readOnly": true
          },
          "isSuccess": {
            "type": "boolean",
            "readOnly": true
          },
          "value": {
            "$ref": "#/components/schemas/SignalValue"
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "JWT Authorization header using the Bearer scheme. Should look like 'Bearer 12345abcdef'",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [ ]
    }
  ]
}