dev.frogspace.stacks.item

spacefrog.dev

Documentation

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

main record

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

Record Key tid Timestamp-based ID

Properties

addedAt string datetime Required

time the citation was first saved. preserve it when editing the note.

collections array of string at-uri Optional

optional collections this citation belongs to, referenced by their record AT-URIs. at most 16.

maxLength: 16 items
note string Optional

optional personal annotation, limited to 16384 graphemes and 65536 UTF-8 bytes. empty is allowed.

maxLength: 65536 bytesmaxGraphemes: 16384 graphemes
rating integer Optional

optional personal rating of the subject on a 1-5 scale.

minimum: 1maximum: 5
readState string Optional

optional reading state of the subject. vocabulary: unread, reading, read.

Known values: unread, reading, read
subject string at-uri Required

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 Required

CID observed for the subject when saved. retain it when the public record changes.

tags array of string Optional

optional inline tag strings on the citation (ADR 0001). at most 32 tags, each at most 64 graphemes.

maxLength: 32 items
View raw schema 
{
  "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"
}

Lexicon Garden

@