org.passingreads.book.note

passingreads.org

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

aboutPublication boolean Optional

If true, this note is about the publication in general rather than this specific physical copy. Such notes may be shown on any book with the same publicationId.

bookPub bytes Optional

The MultiFormat public key of the book.

bookSig bytes Optional

The MultiFormat signature of this record, without this attribute, as created by the private key associated with the book.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

did string did Optional

The DID of the person who wrote this note. Included here, so it's verifiable with the bookSig.

images array of ref #image Optional

Images attached to the note

maxLength: 3 items
note string Optional

The text content of the note left in the book

maxLength: 10000 bytesminLength: 1 bytesmaxGraphemes: 1000 graphemes
spoilerPageNumber string Optional

If set, this note contains spoilers for readers who haven't reached this page (may also contain the special value 'end')

maxLength: 6 bytesminLength: 1 bytes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "properties": {
      "did": {
        "type": "string",
        "format": "did",
        "description": "The DID of the person who wrote this note. Included here, so it's verifiable with the bookSig."
      },
      "book": {
        "ref": "com.atproto.repo.strongRef#main",
        "type": "ref",
        "description": "The book the note is 'in' (a org.passingreads.book.registration)"
      },
      "note": {
        "type": "string",
        "maxLength": 10000,
        "minLength": 1,
        "description": "The text content of the note left in the book",
        "maxGraphemes": 1000
      },
      "images": {
        "type": "array",
        "items": {
          "ref": "#image",
          "type": "ref"
        },
        "maxLength": 3,
        "description": "Images attached to the note"
      },
      "bookPub": {
        "type": "bytes",
        "description": "The MultiFormat public key of the book."
      },
      "bookSig": {
        "type": "bytes",
        "description": "The MultiFormat signature of this record, without this attribute, as created by the private key associated with the book."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "aboutPublication": {
        "type": "boolean",
        "description": "If true, this note is about the publication in general rather than this specific physical copy. Such notes may be shown on any book with the same publicationId."
      },
      "spoilerPageNumber": {
        "type": "string",
        "maxLength": 6,
        "minLength": 1,
        "description": "If set, this note contains spoilers for readers who haven't reached this page (may also contain the special value 'end')"
      }
    }
  }
}
image object

No description available.

Properties

alt string Required

Alt text description of the image

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
image blob Required

No description available.

maxSize: 1.0 MB
View raw schema 
{
  "type": "object",
  "required": [
    "image",
    "alt"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxLength": 10000,
      "description": "Alt text description of the image",
      "maxGraphemes": 1000
    },
    "image": {
      "type": "blob",
      "accept": [
        "image/png",
        "image/jpeg"
      ],
      "maxSize": 1000000
    },
    "aspectRatio": {
      "ref": "org.passingreads.defs#aspectRatio",
      "type": "ref"
    }
  }
}

Lexicon Garden

@