world.ptah.collection

ptah.world

Documentation

Bundles multiple works together. An album, anthology, season, or any curated set of related works.

main record

Bundles multiple works together. An album, anthology, season, or any curated set of related works.

Record Key tid Timestamp-based ID

Properties

canonicalStatus string Optional

The canonical standing of this collection

Known values: world.ptah.defs#canonicalStatusOfficial, world.ptah.defs#canonicalStatusCommunity, world.ptah.defs#canonicalStatusApocryphal
coverImage blob Optional

Cover artwork for the collection

maxSize: 1.0 MB
createdAt string datetime Required

Timestamp when this collection was created

creatorDID string did Required

The permanent identity of the collection's creator

description string Optional

What this collection is about

maxLength: 10240 bytesmaxGraphemes: 1024 graphemes
items array of string at-uri Required

References to the works in this collection

name string Required

The name of the collection

maxLength: 640 bytesmaxGraphemes: 64 graphemes
ordering string Optional

How items in this collection are ordered

Known values: sequential, unordered, chronological
worldReference string at-uri Required

Reference to the world this collection belongs to

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "creatorDID",
      "worldReference",
      "createdAt",
      "items"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 640,
        "description": "The name of the collection",
        "maxGraphemes": 64
      },
      "items": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "description": "References to the works in this collection"
      },
      "ordering": {
        "type": "string",
        "description": "How items in this collection are ordered",
        "knownValues": [
          "sequential",
          "unordered",
          "chronological"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when this collection was created"
      },
      "coverImage": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 1000000,
        "description": "Cover artwork for the collection"
      },
      "creatorDID": {
        "type": "string",
        "format": "did",
        "description": "The permanent identity of the collection's creator"
      },
      "description": {
        "type": "string",
        "maxLength": 10240,
        "description": "What this collection is about",
        "maxGraphemes": 1024
      },
      "worldReference": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the world this collection belongs to"
      },
      "canonicalStatus": {
        "type": "string",
        "description": "The canonical standing of this collection",
        "knownValues": [
          "world.ptah.defs#canonicalStatusOfficial",
          "world.ptah.defs#canonicalStatusCommunity",
          "world.ptah.defs#canonicalStatusApocryphal"
        ]
      }
    }
  },
  "description": "Bundles multiple works together. An album, anthology, season, or any curated set of related works."
}

Lexicon Garden

@