# org.passingreads.book.note

> Published by [passingreads.org](https://lexicon.garden/identity/did:plc:oeipalbxet5jghoqe6b6ctu6)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.note)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.note/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.note/examples)

## Definitions

### `org.passingreads.book.note`

**Type**: `record`

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | No | 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` | No | The book the note is 'in' (a org.passingreads.book.registration) |
| `note` | `string` | No | The text content of the note left in the book |
| `images` | `array` | No | Images attached to the note |
| `bookPub` | `bytes` | No | The MultiFormat public key of the book. |
| `bookSig` | `bytes` | No | The MultiFormat signature of this record, without this attribute, as created by the private key associated with the book. |
| `createdAt` | `string` (datetime) | No |  |
| `aboutPublication` | `boolean` | No | 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` | `string` | No | If set, this note contains spoilers for readers who haven't reached this page (may also contain the special value 'end') |

### `org.passingreads.book.note#image`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `alt` | `string` | Yes | Alt text description of the image |
| `image` | `blob` | Yes |  |
| `aspectRatio` | `ref` → `org.passingreads.defs#aspectRatio` | No |  |

## Raw Schema

```json
{
  "id": "org.passingreads.book.note",
  "defs": {
    "main": {
      "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": {
      "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"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```