# buzz.bookhive.catalogBook

> Published by [bookhive.buzz](https://lexicon.garden/identity/did:plc:enu2j5xjlqsjaylv3du4myh4)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.catalogBook)
- [Documentation](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.catalogBook/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.catalogBook/examples)

## Definitions

### `buzz.bookhive.catalogBook`

**Type**: `record`

A canonical book record in the BookHive catalog

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` | Yes | The book's hive id |
| `cover` | `string` | No | URL to full-size cover image |
| `title` | `string` | Yes | The title of the book |
| `genres` | `array` | No | Genres of the book |
| `rating` | `integer` | No | Average rating (0-5000, where 1000 == 1.0) |
| `series` | `string` | No | Series name if the book is part of a series |
| `source` | `string` | No | The source service name (e.g. Goodreads) |
| `authors` | `string` | Yes | The authors of the book (tab separated) |
| `sourceId` | `string` | No | ID of the book in the source service |
| `coverBlob` | `blob` | No | Uploaded full-size cover image blob |
| `createdAt` | `string` (datetime) | Yes |  |
| `sourceUrl` | `string` | No | URL to the book on the source service |
| `thumbnail` | `string` | Yes | URL to thumbnail image |
| `updatedAt` | `string` (datetime) | Yes |  |
| `description` | `string` | No | Book description/summary |
| `identifiers` | `ref` → `buzz.bookhive.defs#bookIdentifiers` | No | External identifiers for the book |
| `ratingsCount` | `integer` | No | Number of ratings |
| `thumbnailBlob` | `blob` | No | Uploaded thumbnail image blob |

## Raw Schema

```json
{
  "id": "buzz.bookhive.catalogBook",
  "defs": {
    "main": {
      "key": "any",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "id",
          "title",
          "authors",
          "thumbnail",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The book's hive id"
          },
          "cover": {
            "type": "string",
            "description": "URL to full-size cover image"
          },
          "title": {
            "type": "string",
            "maxLength": 512,
            "minLength": 1,
            "description": "The title of the book"
          },
          "genres": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Genres of the book"
          },
          "rating": {
            "type": "integer",
            "maximum": 5000,
            "minimum": 0,
            "description": "Average rating (0-5000, where 1000 == 1.0)"
          },
          "series": {
            "type": "string",
            "description": "Series name if the book is part of a series"
          },
          "source": {
            "type": "string",
            "description": "The source service name (e.g. Goodreads)"
          },
          "authors": {
            "type": "string",
            "maxLength": 512,
            "minLength": 1,
            "description": "The authors of the book (tab separated)"
          },
          "sourceId": {
            "type": "string",
            "description": "ID of the book in the source service"
          },
          "coverBlob": {
            "type": "blob",
            "accept": [
              "image/png",
              "image/jpeg"
            ],
            "maxSize": 2000000,
            "description": "Uploaded full-size cover image blob"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "sourceUrl": {
            "type": "string",
            "description": "URL to the book on the source service"
          },
          "thumbnail": {
            "type": "string",
            "description": "URL to thumbnail image"
          },
          "updatedAt": {
            "type": "string",
            "format": "datetime"
          },
          "description": {
            "type": "string",
            "maxLength": 5000,
            "description": "Book description/summary"
          },
          "identifiers": {
            "ref": "buzz.bookhive.defs#bookIdentifiers",
            "type": "ref",
            "description": "External identifiers for the book"
          },
          "ratingsCount": {
            "type": "integer",
            "description": "Number of ratings"
          },
          "thumbnailBlob": {
            "type": "blob",
            "accept": [
              "image/png",
              "image/jpeg"
            ],
            "maxSize": 1000000,
            "description": "Uploaded thumbnail image blob"
          }
        }
      },
      "description": "A canonical book record in the BookHive catalog"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```