click.croft.inkwell.collection

ewancroft.uk

Documentation

A named, ordered collection of `site.standard.document` poem records.

main record

A named, ordered collection of `site.standard.document` poem records.

Record Key tid Timestamp-based ID

Properties

coverImage blob Optional

Cover image for the collection. Should be ≤1 MB.

maxSize: 1.0 MB
createdAt string datetime Required

Timestamp of when this collection was first created.

description string Optional

An introduction, note, or blurb for the collection.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes
poems array of string at-uri Optional

Ordered list of AT URIs pointing to `site.standard.document` records that comprise this collection. The order is the canonical reading order.

maxLength: 2000 items
publication string at-uri Optional

Optional AT URI of the `site.standard.publication` record this collection belongs to.

title string Required

Title of the collection.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
updatedAt string datetime Optional

Timestamp of the most recent edit to this collection.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "createdAt"
    ],
    "properties": {
      "poems": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 2000,
        "description": "Ordered list of AT URIs pointing to `site.standard.document` records that comprise this collection. The order is the canonical reading order."
      },
      "title": {
        "type": "string",
        "maxLength": 5000,
        "description": "Title of the collection.",
        "maxGraphemes": 500
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of when this collection was first created."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of the most recent edit to this collection."
      },
      "coverImage": {
        "type": "blob",
        "accept": [
          "image/jpeg",
          "image/png",
          "image/webp"
        ],
        "maxSize": 1000000,
        "description": "Cover image for the collection. Should be ≤1 MB."
      },
      "description": {
        "type": "string",
        "maxLength": 30000,
        "description": "An introduction, note, or blurb for the collection.",
        "maxGraphemes": 3000
      },
      "publication": {
        "type": "string",
        "format": "at-uri",
        "description": "Optional AT URI of the `site.standard.publication` record this collection belongs to."
      }
    }
  },
  "description": "A named, ordered collection of `site.standard.document` poem records."
}

Lexicon Garden

@