# net.neodb.mark

> Published by [neodb.net](https://lexicon.garden/identity/did:plc:ui2d3qu2ltydsyskmnuvi4ay)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ui2d3qu2ltydsyskmnuvi4ay/net.neodb.mark)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ui2d3qu2ltydsyskmnuvi4ay/net.neodb.mark/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ui2d3qu2ltydsyskmnuvi4ay/net.neodb.mark/examples)

## Definitions

### `net.neodb.mark`

**Type**: `record`

A shelf entry recording a user's status toward a catalog work, with optional rating, comment and tags.

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tags` | `array` | No |  |
| `rating` | `ref` → `net.neodb.defs#rating` | No |  |
| `status` | `string` | Yes | Shelf the work is on. |
| `comment` | `string` | No | Short comment in plain text. |
| `subject` | `ref` → `net.neodb.defs#subject` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `fediverseUri` | `string` (uri) | No | Fediverse (ActivityPub) object URI of the corresponding post on the originating NeoDB instance. |

## Raw Schema

```json
{
  "id": "net.neodb.mark",
  "defs": {
    "main": {
      "key": "any",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject",
          "status",
          "createdAt"
        ],
        "properties": {
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 640,
              "maxGraphemes": 64
            }
          },
          "rating": {
            "ref": "net.neodb.defs#rating",
            "type": "ref"
          },
          "status": {
            "enum": [
              "wishlist",
              "progress",
              "complete",
              "dropped"
            ],
            "type": "string",
            "description": "Shelf the work is on."
          },
          "comment": {
            "type": "string",
            "maxLength": 10000,
            "description": "Short comment in plain text."
          },
          "subject": {
            "ref": "net.neodb.defs#subject",
            "type": "ref"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "fediverseUri": {
            "type": "string",
            "format": "uri",
            "description": "Fediverse (ActivityPub) object URI of the corresponding post on the originating NeoDB instance."
          }
        }
      },
      "description": "A shelf entry recording a user's status toward a catalog work, with optional rating, comment and tags."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```