A shelf entry recording a user's status toward a catalog work, with optional rating, comment and tags.
Record Key
any
Any valid record key
Properties
comment
string
Optional
Short comment in plain text.
maxLength: 10000 bytescreatedAt
string
datetime
Required
An RFC 3339 formatted timestamp.
fediverseUri
string
uri
Optional
Fediverse (ActivityPub) object URI of the corresponding post on the originating NeoDB instance.
rating
ref
net.neodb.defs#rating
Optional
No description available.
status
string
Required
Shelf the work is on.
Allowed:
wishlist, progress, complete, droppedsubject
ref
net.neodb.defs#subject
Required
No description available.
tags
array
of
string
Optional
No description available.
View raw schema
{
"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."
}