swagger.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "SMart AC Device API",
    "version": "v1"
  },
  "paths": {
    "/devices/{serialNumber}": {
      "get": {
        "tags": [
          "Device"
        ],
        "parameters": [
          {
            "name": "serialNumber",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/authenticate-device": {
      "post": {
        "tags": [
          "DeviceAuthZ"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeviceAuthenticationModel"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/DeviceAuthenticationModel"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/DeviceAuthenticationModel"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/devices": {
      "get": {
        "tags": [
          "Devices"
        ],
        "parameters": [
          {
            "name": "count",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      },
      "post": {
        "tags": [
          "Devices"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Device"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/Device"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/Device"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/devices/{deviceId}/measurements/{from}/{to}": {
      "get": {
        "tags": [
          "Measurement"
        ],
        "parameters": [
          {
            "name": "deviceId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      },
      "post": {
        "tags": [
          "Measurement"
        ],
        "parameters": [
          {
            "name": "deviceId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Measurements",
            "in": "query",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Measurement"
              }
            }
          },
          {
            "name": "from",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "/authenticate-user": {
      "post": {
        "tags": [
          "UserAuth"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserAuthenticationModel"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/UserAuthenticationModel"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/UserAuthenticationModel"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DeviceAuthenticationModel": {
        "required": [
          "secret",
          "serialNumber"
        ],
        "type": "object",
        "properties": {
          "serialNumber": {
            "type": "string"
          },
          "secret": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "Device": {
        "required": [
          "firmwareVersion",
          "secret",
          "serialNumber",
          "status"
        ],
        "type": "object",
        "properties": {
          "serialNumber": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "registrationDate": {
            "type": "string",
            "nullable": true
          },
          "firmwareVersion": {
            "type": "string"
          },
          "secret": {
            "type": "string"
          },
          "inAlarm": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "Measurement": {
        "required": [
          "id",
          "recordedTime"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "deviceSerialNumber": {
            "type": "string",
            "nullable": true
          },
          "recordedTime": {
            "type": "string"
          },
          "airHumidity": {
            "type": "number",
            "format": "double"
          },
          "carbonMonoxide": {
            "type": "number",
            "format": "double"
          },
          "temperature": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "UserAuthenticationModel": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "nullable": true
          },
          "password": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}