Firmware

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kontaktio/main/json-schema/kontaktio-firmware-schema.json",
  "title": "Firmware",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kontaktio-firmware-api-openapi.yml#/components/schemas/Firmware",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "UUID",
      "description": "Firmware id."
    },
    "name": {
      "type": "string",
      "description": "Firmware name"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optional Firmware description"
    },
    "deviceType": {
      "type": "string",
      "description": "Type of a device that the Firmware applies to",
      "enum": [
        "BEACON",
        "GATEWAY"
      ]
    },
    "uniqueId": {
      "type": "array",
      "description": "List of Unique IDs of beacons that this Firmware can be applied to",
      "items": {
        "type": "string"
      }
    },
    "validVersions": {
      "description": "List of Firmware versions from which it's possible to update to the returned Firmware",
      "type": "string"
    },
    "scheduled": {
      "type": "boolean",
      "description": "Flag indicating whether an optional firmware should be made available for upgrading beacons (`true`) or not (`false`)"
    },
    "important": {
      "type": "boolean",
      "description": "Flag indicating whether this Firmware should be considered important (`true`) or just a minor update (`false`)"
    },
    "optional": {
      "type": "boolean",
      "description": "Flag indicating whether this Firmware is optional (`true`) or not ('false')"
    },
    "url": {
      "type": "string",
      "format": "URL",
      "description": "Link to a binary file with the Firmware"
    },
    "fileExtension": {
      "type": "string",
      "description": "Extension of the Firmware file"
    },
    "crc32": {
      "type": "string",
      "description": "Checksum"
    }
  }
}