LibrarySetupStatusDto

Endpoints · All schemas

Field	Required	Description
canFinish	Yes	boolean
installation	Yes	string
origin	Yes	string
phase	Yes	string
regeneration	No	object
rescanComplete	Yes	boolean
revision	Yes	string
setupRequired	Yes	boolean
sync	Yes	object
verificationPassed	Yes	boolean

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "canFinish": {
      "type": "boolean"
    },
    "installation": {
      "type": "string"
    },
    "origin": {
      "enum": [
        "new_import",
        "new_library",
        "restored_library"
      ],
      "type": "string"
    },
    "phase": {
      "enum": [
        "awaiting-account",
        "rescanning",
        "verifying",
        "needs-attention",
        "complete"
      ],
      "type": "string"
    },
    "regeneration": {
      "nullable": true,
      "properties": {
        "blocked": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "completed": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "failed": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "needsAttention": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "preparedAt": {
          "nullable": true,
          "type": "string"
        },
        "reasons": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "runId": {
          "format": "uuid",
          "nullable": true,
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
          "type": "string"
        },
        "startedAt": {
          "nullable": true,
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "total": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "runId",
        "state",
        "preparedAt",
        "startedAt",
        "completed",
        "total",
        "failed",
        "blocked",
        "needsAttention",
        "reasons"
      ],
      "type": "object"
    },
    "rescanComplete": {
      "type": "boolean"
    },
    "revision": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "setupRequired": {
      "type": "boolean"
    },
    "sync": {
      "properties": {
        "authenticated": {
          "type": "boolean"
        },
        "catalogComplete": {
          "type": "boolean"
        },
        "previewsReady": {
          "type": "boolean"
        }
      },
      "required": [
        "authenticated",
        "catalogComplete",
        "previewsReady"
      ],
      "type": "object"
    },
    "verificationPassed": {
      "type": "boolean"
    }
  },
  "required": [
    "canFinish",
    "installation",
    "origin",
    "phase",
    "rescanComplete",
    "revision",
    "setupRequired",
    "sync",
    "verificationPassed"
  ],
  "type": "object"
}