Skip to content

AlbumSourceResolvedDto

Endpoints · All schemas

FieldRequiredDescription
albumIdYesThe server album the source is linked to
albumNameYesThe server album name
createdAtYesWhen the link was made
deviceKeyYesThe device the source id belongs to, when it is device-local
idYesLink ID
kindYesSee definition below
lastSourceNameYesThe phone name the server album last followed (the rename guard)
outcomeYesSee definition below
sourceIdYesThe source on the phone
updatedAtYesWhen 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, AlbumSourceOutcome

{
  "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"
    },
    "outcome": {
      "$ref": "#/components/schemas/AlbumSourceOutcome"
    },
    "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",
    "outcome",
    "sourceId",
    "updatedAt"
  ],
  "type": "object"
}