SharedSpaceAlbumResponseDto

Endpoints · All schemas

Field	Required	Description
albumName	Yes	The linked album name
assetCount	Yes	Items that are in both this album and the shared space. Media marked sensitive, and Locked media, are not counted.
canUnlink	Yes	True when the caller may remove this link
icon	Yes	Icon: a Material Design Icons name (null = default icon)
id	Yes	The linked album ID
linkedAt	Yes	When the album was linked
linkedBy	Yes	The member who linked this album
thumbnailAssetId	Yes	An item that is already in the shared space, used as the tile picture

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: UserResponseDto

{
  "properties": {
    "albumName": {
      "description": "The linked album name",
      "type": "string"
    },
    "assetCount": {
      "description": "Items that are in both this album and the shared space. Media marked sensitive, and Locked media, are not counted.",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "canUnlink": {
      "description": "True when the caller may remove this link",
      "type": "boolean"
    },
    "icon": {
      "description": "Icon: a Material Design Icons name (null = default icon)",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "The linked album 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"
    },
    "linkedAt": {
      "description": "When the album was linked",
      "format": "date-time",
      "type": "string"
    },
    "linkedBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserResponseDto"
        }
      ],
      "description": "The member who linked this album",
      "nullable": true
    },
    "thumbnailAssetId": {
      "description": "An item that is already in the shared space, used as the tile picture",
      "format": "uuid",
      "nullable": true,
      "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"
    }
  },
  "required": [
    "albumName",
    "assetCount",
    "canUnlink",
    "icon",
    "id",
    "linkedAt",
    "linkedBy",
    "thumbnailAssetId"
  ],
  "type": "object"
}