# org.passingreads.book.group

> 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.group)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.group/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.group/examples)

## Definitions

### `org.passingreads.book.group`

**Type**: `record`

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

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | Display name of the group. |
| `books` | `array` | Yes | The books that belong to this group (each an org.passingreads.book.registration). |
| `createdAt` | `string` (datetime) | Yes |  |
| `updatedAt` | `string` (datetime) | No |  |

## Raw Schema

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