LibraryRemovalReviewDto

Endpoints · All schemas

Field	Required	Description
albums	Yes	Albums that lose items
faces	Yes	Detected faces that will be removed with their items
libraryId	Yes	Library ID
name	Yes	Library name, to be typed to confirm
offline	Yes	Items already offline
originalsKept	Yes	Source files in the import folders are never deleted
ownerId	Yes	Owner user ID
photos	Yes	Indexed photos that will be removed
reviewToken	Yes	Present this to confirm the removal
scanActive	Yes	A scan is running and will be stopped
sharedLinks	Yes	Shared links that lose items
total	Yes	Indexed items that will be removed
usage	Yes	Original bytes those items reference
videos	Yes	Indexed videos that will be removed

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": {
    "albums": {
      "description": "Albums that lose items",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "faces": {
      "description": "Detected faces that will be removed with their items",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "libraryId": {
      "description": "Library ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "name": {
      "description": "Library name, to be typed to confirm",
      "type": "string"
    },
    "offline": {
      "description": "Items already offline",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "originalsKept": {
      "description": "Source files in the import folders are never deleted",
      "type": "boolean"
    },
    "ownerId": {
      "description": "Owner user ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "photos": {
      "description": "Indexed photos that will be removed",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "reviewToken": {
      "description": "Present this to confirm the removal",
      "type": "string"
    },
    "scanActive": {
      "description": "A scan is running and will be stopped",
      "type": "boolean"
    },
    "sharedLinks": {
      "description": "Shared links that lose items",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "total": {
      "description": "Indexed items that will be removed",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "usage": {
      "description": "Original bytes those items reference",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "videos": {
      "description": "Indexed videos that will be removed",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "albums",
    "faces",
    "libraryId",
    "name",
    "offline",
    "originalsKept",
    "ownerId",
    "photos",
    "reviewToken",
    "scanActive",
    "sharedLinks",
    "total",
    "usage",
    "videos"
  ],
  "type": "object"
}