dev.ocbwoy3.dotsyncd.device

ocbwoy3.dev

Documentation

main record

Record Key any Any valid record key

Properties

configInUse string uri Required

The config in use on the device

maxLength: 100 bytesminLength: 1 bytes

createdAt string datetime Required

The date and time when the device was added

distro ref #distro Required

The distro specifications of the device

name string Required

The name of the device (e.g. Gaming PC, Laptop)

maxLength: 100 bytesminLength: 1 bytes

rig ref #rig Required

The hardware specifications of the device

setup ref #setup Required

The software setup of the device

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "rig",
      "setup",
      "createdAt",
      "distro",
      "configInUse"
    ],
    "properties": {
      "rig": {
        "ref": "#rig",
        "type": "ref",
        "description": "The hardware specifications of the device"
      },
      "name": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "The name of the device (e.g. Gaming PC, Laptop)"
      },
      "setup": {
        "ref": "#setup",
        "type": "ref",
        "description": "The software setup of the device"
      },
      "distro": {
        "ref": "#distro",
        "type": "ref",
        "description": "The distro specifications of the device"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "The date and time when the device was added"
      },
      "configInUse": {
        "type": "string",
        "format": "uri",
        "maxLength": 100,
        "minLength": 1,
        "description": "The config in use on the device"
      }
    }
  }
}

distro object

Properties

id string Required

The ID of the Linux distribution (e.g. nixos, gentoo)

maxLength: 50 bytesminLength: 1 bytes

name string Required

The name of the Linux distribution (e.g. NixOS, Gentoo Linux)

maxLength: 50 bytesminLength: 1 bytes

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "The ID of the Linux distribution (e.g. nixos, gentoo)"
    },
    "name": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "The name of the Linux distribution (e.g. NixOS, Gentoo Linux)"
    }
  }
}

rig object

Properties

cpu string Required

The CPU model of the device

maxLength: 100 bytesminLength: 1 bytes

disk string Required

The amount of space in / (in numBlocks*blockSize, e.g. 32767*1024)

maxLength: 30 bytesminLength: 1 bytes

diskType string Required

The type of filesystem on / (e.g. ext4, btrfs)

maxLength: 20 bytesminLength: 1 bytes

gpu string Required

The GPU model of the device

maxLength: 100 bytesminLength: 1 bytes

ram string Required

The amount of RAM in the device (e.g. 16GB)

maxLength: 20 bytesminLength: 1 bytes

View raw schema

{
  "type": "object",
  "required": [
    "cpu",
    "gpu",
    "ram",
    "disk",
    "diskType"
  ],
  "properties": {
    "cpu": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "The CPU model of the device"
    },
    "gpu": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "The GPU model of the device"
    },
    "ram": {
      "type": "string",
      "maxLength": 20,
      "minLength": 1,
      "description": "The amount of RAM in the device (e.g. 16GB)"
    },
    "disk": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "The amount of space in / (in numBlocks*blockSize, e.g. 32767*1024)"
    },
    "diskType": {
      "type": "string",
      "maxLength": 20,
      "minLength": 1,
      "description": "The type of filesystem on / (e.g. ext4, btrfs)"
    }
  }
}

setup object

Properties

wm string Required

The WM/DE used on the device derived from $XDG_CURRENT_DESKTOP (e.g. Hyprland)

maxLength: 50 bytesminLength: 1 bytes

View raw schema

{
  "type": "object",
  "required": [
    "wm"
  ],
  "properties": {
    "wm": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "The WM/DE used on the device derived from $XDG_CURRENT_DESKTOP (e.g. Hyprland)"
    }
  }
}