
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cambrionix Downloads API",
    "description": "The downloads API provides access to Cambrionix firmware/software downloads and related information.",
    "version": "1.0"
  },
  "servers": [
    {
      "description": "Cambrionix Connect",
      "url": "/api"
    }
  ],
  "tags": [
    {
      "name": "Software",
      "description": "Retrieve links to our software releases."
    },
    {
      "name": "Firmware",
      "description": "Firmware related endpoints."
    }
  ],
  "paths": {
    "/downloads/v1/firmware/{hardwareFirmwareId}": {
      "get": {
        "summary": "Get a specific firmware file",
        "description": "Retrieve details of a specific firmware file by its Id.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hardwareFirmwareId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "0000005B6D541D50",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "0000005B6D541D50"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetASpecificFirmwareFileResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getASpecificFirmwareFile"
      }
    },
    "/downloads/v1/firmware/hardware-families/{hardwareFamilyId}": {
      "get": {
        "summary": "Get firmware files for a specific hardware family",
        "description": "Retrieve a list of firmware files associated with a specific hardware family Id.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hardwareFamilyId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          },
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetFirmwareFilesForASpecificHardwareFamilyResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getFirmwareFilesForASpecificHardwareFamily"
      }
    },
    "/downloads/v1/firmware/hardware-families/{hardwareFamilyId}/hardware/{hardwareId}": {
      "get": {
        "summary": "Get firmware files for a specific hardware",
        "description": "Retrieve a list of firmware files associated with a specific hardware Id.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hardwareFamilyId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          },
          {
            "name": "hardwareId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          },
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetFirmwareFilesForASpecificHardwareResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getFirmwareFilesForASpecificHardware"
      }
    },
    "/downloads/v1/firmware/hardware-families/{hardwareFamilyId}/hardware/{hardwareId}/latest": {
      "get": {
        "summary": "Get the latest firmware file for a specific hardware",
        "description": "Retrieve the latest firmware file associated with a specific hardware Id.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hardwareFamilyId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          },
          {
            "name": "hardwareId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTheLatestFirmwareFileForASpecificHardwareResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getTheLatestFirmwareFileForASpecificHardware"
      }
    },
    "/downloads/v1/firmware/hardware-families/{hardwareFamilyId}/latest": {
      "get": {
        "summary": "Get the latest firmware files for a specific hardware family",
        "description": "Retrieve the latest firmware files associated with a specific hardware family Id.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hardwareFamilyId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          },
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTheLatestFirmwareFilesForASpecificHardwareFamilyResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getTheLatestFirmwareFilesForASpecificHardwareFamily"
      }
    },
    "/downloads/v1/firmware/hubs": {
      "get": {
        "summary": "List all available firmware for hubs",
        "description": "List all available firmware for hubs.",
        "tags": [
          "Firmware"
        ],
        "parameters": [],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FirmwareFileLink"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listAllAvailableFirmwareForHubs"
      }
    },
    "/downloads/v1/firmware/hubs/{hubIdentifier}": {
      "get": {
        "summary": "List Firmware for a Specific Hub",
        "description": "List the firmware versions available for a specific hub model.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hubIdentifier",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "value",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "value"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FirmwareFileLink"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listFirmwareForASpecificHub"
      }
    },
    "/downloads/v1/firmware/hubs/{hubIdentifier}/latest": {
      "get": {
        "summary": "Get Latest Firmware for a Specific Hub",
        "description": "Get the latest firmware for a specific hub model.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hubIdentifier",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "value",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "value"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/FirmwareFileLink"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getLatestFirmwareForASpecificHub"
      }
    },
    "/downloads/v1/firmware/hubs/{hubIdentifier}/release-notes": {
      "get": {
        "summary": "Get Release Notes for a Specific Hub",
        "description": "Get the release notes for a specific hub model.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "hubIdentifier",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "value",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "value"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetReleaseNotesForASpecificHubResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getReleaseNotesForASpecificHub"
      }
    },
    "/downloads/v1/firmware/types": {
      "get": {
        "summary": "List all available firmware types",
        "description": "List all available firmware types.",
        "tags": [
          "Firmware"
        ],
        "parameters": [],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FirmwareTypeRecord"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listAllAvailableFirmwareTypes"
      }
    },
    "/downloads/v1/firmware/types/{firmwareTypeId}": {
      "get": {
        "summary": "List all available firmware of a specified firmware type",
        "description": "List all available firmware of a specified firmware type.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "firmwareTypeId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "0000005B6D541D50",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "0000005B6D541D50"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FirmwareFileLink"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listAllAvailableFirmwareOfASpecifiedFirmwareType"
      }
    },
    "/downloads/v1/firmware/types/{firmwareTypeId}/latest": {
      "get": {
        "summary": "List the latest available firmware of a specified type",
        "description": "List the latest available firmware of a specified type.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "firmwareTypeId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "0000005B6D541D50",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "0000005B6D541D50"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FirmwareFileLink"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listTheLatestAvailableFirmwareOfASpecifiedType"
      }
    },
    "/downloads/v1/firmware/types/{firmwareTypeId}/release-notes": {
      "get": {
        "summary": "List the firmware release notes of a specified type",
        "description": "List the firmware release notes of a specified type.",
        "tags": [
          "Firmware"
        ],
        "parameters": [
          {
            "name": "firmwareTypeId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "0000005B6D541D50",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "0000005B6D541D50"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListTheFirmwareReleaseNotesOfASpecifiedTypeResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listTheFirmwareReleaseNotesOfASpecifiedType"
      }
    },
    "/downloads/v1/software/cambrionix-cli/{platform}/{versionId}": {
      "get": {
        "summary": "Get Cambrionix CLI install script URL",
        "description": "Get a signed Cambrionix CLI install script URL for a platform and version. `minutes` sets how long the link works (default 15, at most 30 days).",
        "tags": [
          "Software"
        ],
        "parameters": [
          {
            "name": "platform",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "windows",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "windows",
              "enum": [
                "windows",
                "macos",
                "linuxArm32",
                "linuxDeb64"
              ]
            }
          },
          {
            "name": "versionId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "value",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "value"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Downloads.Software.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "No content"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getCambrionixCliInstallScriptUrl"
      }
    },
    "/downloads/v1/software/cambrionix-hub-viewer/{platform}/latest": {
      "get": {
        "summary": "Download the latest version of the Cambrionix Hub Viewer",
        "description": "Download the latest version of the Cambrionix Hub Viewer for a specific platform.",
        "tags": [
          "Software"
        ],
        "parameters": [
          {
            "name": "platform",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "windows",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "windows",
              "enum": [
                "windows",
                "macos",
                "linuxArm32",
                "linuxDeb64"
              ]
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Downloads.Software.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "No content"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "downloadTheLatestVersionOfTheCambrionixHubViewer"
      }
    },
    "/downloads/v1/software/connect-setup/{platform}/beta": {
      "get": {
        "summary": "Download the latest beta version of the Connect Setup",
        "description": "Download the latest beta version of the Connect Setup for a specific platform.",
        "tags": [
          "Software"
        ],
        "parameters": [
          {
            "name": "platform",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "windows",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "windows",
              "enum": [
                "windows",
                "macos",
                "linuxArm32",
                "linuxDeb64"
              ]
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Downloads.Software.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "No content"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "downloadTheLatestBetaVersionOfTheConnectSetup"
      }
    },
    "/downloads/v1/software/connect-setup/{platform}/latest": {
      "get": {
        "summary": "Download the latest version of the Connect Setup",
        "description": "Download the latest version of the Connect Setup for a specific platform.",
        "tags": [
          "Software"
        ],
        "parameters": [
          {
            "name": "platform",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "windows",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "windows",
              "enum": [
                "windows",
                "macos",
                "linuxArm32",
                "linuxDeb64"
              ]
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Downloads.Software.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "No content"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "downloadTheLatestVersionOfTheConnectSetup"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "description": "Access token from the organization token endpoint, `POST /api/v1/organizations/{organizationId}/oauth2/token` on the Connect host, using the `client_credentials` grant with a service account.",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "responses": {
      "Error": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ForbiddenError": {
        "description": "Forbidden: the token is valid but does not allow this request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          }
        }
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "FirmwareFileLink": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "hash": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "hash",
          "url",
          "version"
        ],
        "additionalProperties": false
      },
      "FirmwareTypeRecord": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "name",
          "products"
        ],
        "additionalProperties": false
      },
      "GetASpecificFirmwareFileResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "_metadata": {
                "type": "object",
                "properties": {
                  "continuationToken": {
                    "type": "string"
                  },
                  "limit": {
                    "type": "number"
                  },
                  "total": {
                    "type": "number"
                  }
                },
                "additionalProperties": false,
                "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                "title": "Connect API Response Metadata"
              },
              "result": {
                "type": "object",
                "properties": {
                  "checksums": {
                    "type": "object",
                    "properties": {
                      "md5": {
                        "type": "string",
                        "minLength": 32,
                        "maxLength": 32
                      },
                      "sha1": {
                        "type": "string",
                        "minLength": 40,
                        "maxLength": 40
                      },
                      "sha256": {
                        "type": "string",
                        "minLength": 64,
                        "maxLength": 64
                      }
                    },
                    "additionalProperties": false
                  },
                  "hardware": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "hardwareFamily": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                            }
                          },
                          "required": [
                            "id"
                          ],
                          "additionalProperties": false
                        },
                        "id": {
                          "type": "string",
                          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                        }
                      },
                      "required": [
                        "hardwareFamily",
                        "id"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "id": {
                    "type": "string"
                  },
                  "legacy": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "type"
                    ],
                    "additionalProperties": false
                  },
                  "type": {
                    "type": "string",
                    "const": "CambrionixHub"
                  },
                  "url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "version": {
                    "type": "string"
                  }
                },
                "required": [
                  "checksums",
                  "hardware",
                  "id",
                  "legacy",
                  "type",
                  "url",
                  "version"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "result"
            ],
            "additionalProperties": false,
            "description": "Response schema with result and metadata",
            "title": "Connect API Response"
          },
          {
            "type": "object",
            "properties": {
              "_metadata": {
                "type": "object",
                "properties": {
                  "continuationToken": {
                    "type": "string"
                  },
                  "limit": {
                    "type": "number"
                  },
                  "total": {
                    "type": "number"
                  }
                },
                "additionalProperties": false,
                "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                "title": "Connect API Response Metadata"
              },
              "result": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/FirmwareTypeRecord"
                }
              }
            },
            "required": [
              "result"
            ],
            "additionalProperties": false,
            "description": "Response schema with result and metadata",
            "title": "Connect API Response"
          }
        ]
      },
      "GetFirmwareFilesForASpecificHardwareFamilyResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "checksums": {
                  "type": "object",
                  "properties": {
                    "md5": {
                      "type": "string",
                      "minLength": 32,
                      "maxLength": 32
                    },
                    "sha1": {
                      "type": "string",
                      "minLength": 40,
                      "maxLength": 40
                    },
                    "sha256": {
                      "type": "string",
                      "minLength": 64,
                      "maxLength": 64
                    }
                  },
                  "additionalProperties": false
                },
                "hardware": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "hardwareFamily": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                          }
                        },
                        "required": [
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                      }
                    },
                    "required": [
                      "hardwareFamily",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "id": {
                  "type": "string"
                },
                "legacy": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "type"
                  ],
                  "additionalProperties": false
                },
                "type": {
                  "type": "string",
                  "const": "CambrionixHub"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "version": {
                  "type": "string"
                }
              },
              "required": [
                "checksums",
                "hardware",
                "id",
                "legacy",
                "type",
                "url",
                "version"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "GetFirmwareFilesForASpecificHardwareResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "checksums": {
                  "type": "object",
                  "properties": {
                    "md5": {
                      "type": "string",
                      "minLength": 32,
                      "maxLength": 32
                    },
                    "sha1": {
                      "type": "string",
                      "minLength": 40,
                      "maxLength": 40
                    },
                    "sha256": {
                      "type": "string",
                      "minLength": 64,
                      "maxLength": 64
                    }
                  },
                  "additionalProperties": false
                },
                "hardware": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "hardwareFamily": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                          }
                        },
                        "required": [
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                      }
                    },
                    "required": [
                      "hardwareFamily",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "id": {
                  "type": "string"
                },
                "legacy": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "type"
                  ],
                  "additionalProperties": false
                },
                "type": {
                  "type": "string",
                  "const": "CambrionixHub"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "version": {
                  "type": "string"
                }
              },
              "required": [
                "checksums",
                "hardware",
                "id",
                "legacy",
                "type",
                "url",
                "version"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "GetReleaseNotesForASpecificHubResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "string"
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "GetTheLatestFirmwareFileForASpecificHardwareResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "object",
            "properties": {
              "checksums": {
                "type": "object",
                "properties": {
                  "md5": {
                    "type": "string",
                    "minLength": 32,
                    "maxLength": 32
                  },
                  "sha1": {
                    "type": "string",
                    "minLength": 40,
                    "maxLength": 40
                  },
                  "sha256": {
                    "type": "string",
                    "minLength": 64,
                    "maxLength": 64
                  }
                },
                "additionalProperties": false
              },
              "hardware": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "hardwareFamily": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                    }
                  },
                  "required": [
                    "hardwareFamily",
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "id": {
                "type": "string"
              },
              "legacy": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "type"
                ],
                "additionalProperties": false
              },
              "type": {
                "type": "string",
                "const": "CambrionixHub"
              },
              "url": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "string"
              }
            },
            "required": [
              "checksums",
              "hardware",
              "id",
              "legacy",
              "type",
              "url",
              "version"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "GetTheLatestFirmwareFilesForASpecificHardwareFamilyResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "checksums": {
                  "type": "object",
                  "properties": {
                    "md5": {
                      "type": "string",
                      "minLength": 32,
                      "maxLength": 32
                    },
                    "sha1": {
                      "type": "string",
                      "minLength": 40,
                      "maxLength": 40
                    },
                    "sha256": {
                      "type": "string",
                      "minLength": 64,
                      "maxLength": 64
                    }
                  },
                  "additionalProperties": false
                },
                "hardware": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "hardwareFamily": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                          }
                        },
                        "required": [
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                      }
                    },
                    "required": [
                      "hardwareFamily",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "id": {
                  "type": "string"
                },
                "legacy": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "type"
                  ],
                  "additionalProperties": false
                },
                "type": {
                  "type": "string",
                  "const": "CambrionixHub"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "version": {
                  "type": "string"
                }
              },
              "required": [
                "checksums",
                "hardware",
                "id",
                "legacy",
                "type",
                "url",
                "version"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "ListTheFirmwareReleaseNotesOfASpecifiedTypeResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "string"
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "UnauthorizedError": {
        "type": "object",
        "required": [
          "code",
          "message",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "enum": [
              401
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Unauthorized"
            ]
          },
          "detail": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    }
  }
}
