AlbumSourceUpdateResponseDto

Endpoints · All schemas

Field	Required	Description
albumId	Yes	The server album the source is linked to
albumName	Yes	The server album name
createdAt	Yes	When the link was made
deviceKey	Yes	The device the source id belongs to, when it is device-local
id	Yes	Link ID
kind	Yes	See definition below
lastSourceName	Yes	The phone name the server album last followed (the rename guard)
renamed	Yes	Whether the server album was renamed (only while its name still equalled lastSourceName)
sourceId	Yes	The source on the phone
updatedAt	Yes	When the link last changed

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.

Field definitions: AlbumSourceKind

{
  "properties": {
    "albumId": {
      "description": "The server album the source is linked to",
      "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"
    },
    "albumName": {
      "description": "The server album name",
      "type": "string"
    },
    "createdAt": {
      "description": "When the link was made",
      "format": "date-time",
      "type": "string"
    },
    "deviceKey": {
      "description": "The device the source id belongs to, when it is device-local",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "Link 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"
    },
    "kind": {
      "$ref": "#/components/schemas/AlbumSourceKind"
    },
    "lastSourceName": {
      "description": "The phone name the server album last followed (the rename guard)",
      "type": "string"
    },
    "renamed": {
      "description": "Whether the server album was renamed (only while its name still equalled lastSourceName)",
      "type": "boolean"
    },
    "sourceId": {
      "description": "The source on the phone",
      "type": "string"
    },
    "updatedAt": {
      "description": "When the link last changed",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "albumId",
    "albumName",
    "createdAt",
    "deviceKey",
    "id",
    "kind",
    "lastSourceName",
    "renamed",
    "sourceId",
    "updatedAt"
  ],
  "type": "object"
}