# dev.frogspace.stacks.item

> Published by [spacefrog.dev](https://lexicon.garden/identity/did:plc:b3ddarwfwuulrq7p2cfwhvmz)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:b3ddarwfwuulrq7p2cfwhvmz/dev.frogspace.stacks.item)
- [Documentation](https://lexicon.garden/lexicon/did:plc:b3ddarwfwuulrq7p2cfwhvmz/dev.frogspace.stacks.item/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:b3ddarwfwuulrq7p2cfwhvmz/dev.frogspace.stacks.item/examples)

## Definitions

### `dev.frogspace.stacks.item`

**Type**: `record`

citation record. the annotation author comes from the verified repo context. no subject content or snapshots are stored.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `addedAt` | `string` (datetime) | Yes | time the citation was first saved. preserve it when editing the note. |
| `collections` | `array` | No | optional collections this citation belongs to, referenced by their record AT-URIs. at most 16. |
| `note` | `string` | No | optional personal annotation, limited to 16384 graphemes and 65536 UTF-8 bytes. empty is allowed. |
| `rating` | `integer` | No | optional personal rating of the subject on a 1-5 scale. |
| `readState` | `string` | No | optional reading state of the subject. vocabulary: unread, reading, read. |
| `subject` | `string` (at-uri) | Yes | full public record AT-URI with a DID authority, collection and record key. clients enforce these additional constraints. any public collection is supported. |
| `subjectCid` | `string` (cid) | Yes | CID observed for the subject when saved. retain it when the public record changes. |
| `tags` | `array` | No | optional inline tag strings on the citation (ADR 0001). at most 32 tags, each at most 64 graphemes. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "citation record. the annotation author comes from the verified repo context. no subject content or snapshots are stored.",
      "key": "tid",
      "record": {
        "properties": {
          "addedAt": {
            "description": "time the citation was first saved. preserve it when editing the note.",
            "format": "datetime",
            "type": "string"
          },
          "collections": {
            "description": "optional collections this citation belongs to, referenced by their record AT-URIs. at most 16.",
            "items": {
              "description": "full in-space AT-URI of a dev.frogspace.stacks.collection record in the owner's library space.",
              "format": "at-uri",
              "type": "string"
            },
            "maxLength": 16,
            "type": "array"
          },
          "note": {
            "description": "optional personal annotation, limited to 16384 graphemes and 65536 UTF-8 bytes. empty is allowed.",
            "maxGraphemes": 16384,
            "maxLength": 65536,
            "type": "string"
          },
          "rating": {
            "description": "optional personal rating of the subject on a 1-5 scale.",
            "maximum": 5,
            "minimum": 1,
            "type": "integer"
          },
          "readState": {
            "description": "optional reading state of the subject. vocabulary: unread, reading, read.",
            "knownValues": [
              "unread",
              "reading",
              "read"
            ],
            "type": "string"
          },
          "subject": {
            "description": "full public record AT-URI with a DID authority, collection and record key. clients enforce these additional constraints. any public collection is supported.",
            "format": "at-uri",
            "type": "string"
          },
          "subjectCid": {
            "description": "CID observed for the subject when saved. retain it when the public record changes.",
            "format": "cid",
            "type": "string"
          },
          "tags": {
            "description": "optional inline tag strings on the citation (ADR 0001). at most 32 tags, each at most 64 graphemes.",
            "items": {
              "description": "inline tag string. clients enforce uniqueness within the array.",
              "maxGraphemes": 64,
              "maxLength": 256,
              "type": "string"
            },
            "maxLength": 32,
            "type": "array"
          }
        },
        "required": [
          "subject",
          "subjectCid",
          "addedAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "dev.frogspace.stacks.item",
  "lexicon": 1
}
```
