org.passingreads.book.group Documentation (EN)

main record

A named collection of books in a user's library (e.g. 'For the school', 'Take to Spain').

Record Key tid Timestamp-based ID

Properties

books array of ref com.atproto.repo.strongRef#main Required

The books that belong to this group (each an org.passingreads.book.registration).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

name string Required

Display name of the group.

maxLength: 256 bytesminLength: 1 bytesmaxGraphemes: 64 graphemes

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "books",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 256,
        "minLength": 1,
        "description": "Display name of the group.",
        "maxGraphemes": 64
      },
      "books": {
        "type": "array",
        "items": {
          "ref": "com.atproto.repo.strongRef#main",
          "type": "ref"
        },
        "description": "The books that belong to this group (each an org.passingreads.book.registration)."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      }
    }
  },
  "description": "A named collection of books in a user's library (e.g. 'For the school', 'Take to Spain')."
}