app.standard-reader.collection

standard-reader.app

Documentation

Curated magazine collection manifest for a site.standard.document. Uses the same record key as the document it extends so both records can be fetched with one predictable pair of GETs.

main record

Curated magazine collection manifest for a site.standard.document. Uses the same record key as the document it extends so both records can be fetched with one predictable pair of GETs.

Record Key any Any valid record key

Properties

createdAt string datetime Required

When the collection manifest was first published.

document string at-uri Required

AT URI of the site.standard.document record this collection renders.

updatedAt string datetime Optional

When the collection manifest was last edited.

View raw schema 
{
  "description": "Curated magazine collection manifest for a site.standard.document. Uses the same record key as the document it extends so both records can be fetched with one predictable pair of GETs.",
  "key": "any",
  "record": {
    "properties": {
      "colophon": {
        "ref": "app.standard-reader.collection#colophon",
        "type": "ref"
      },
      "createdAt": {
        "description": "When the collection manifest was first published.",
        "format": "datetime",
        "type": "string"
      },
      "document": {
        "description": "AT URI of the site.standard.document record this collection renders.",
        "format": "at-uri",
        "type": "string"
      },
      "editorial": {
        "ref": "app.standard-reader.collection#editorial",
        "type": "ref"
      },
      "items": {
        "description": "Ordered curated articles plus optional per-item notes.",
        "items": {
          "ref": "app.standard-reader.collection#item",
          "type": "ref"
        },
        "maxLength": 42,
        "type": "array"
      },
      "updatedAt": {
        "description": "When the collection manifest was last edited.",
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "document",
      "items",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
colophon object

Optional closing credits on the magazine end spread.

Properties

body union Optional

Colophon body as Markpub markdown (legacy plain string accepted on read during migration).

Known types:
View raw schema 
{
  "description": "Optional closing credits on the magazine end spread.",
  "properties": {
    "body": {
      "description": "Colophon body as Markpub markdown (legacy plain string accepted on read during migration).",
      "refs": [
        "at.markpub.markdown"
      ],
      "type": "union"
    }
  },
  "type": "object"
}
documentLink object

Inverse link entry for site.standard.document#links pointing back at this collection sidecar.

Properties

uri string at-uri Required

AT URI of the app.standard-reader.collection sidecar record.

View raw schema 
{
  "description": "Inverse link entry for site.standard.document#links pointing back at this collection sidecar.",
  "properties": {
    "uri": {
      "description": "AT URI of the app.standard-reader.collection sidecar record.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri"
  ],
  "type": "object"
}
editorial object

Optional editorial intro shown ahead of the curated pieces.

Properties

body union Optional

Editorial body as Markpub markdown (legacy plain string accepted on read during migration).

Known types:
title string Optional

No description available.

maxLength: 160 bytes
View raw schema 
{
  "description": "Optional editorial intro shown ahead of the curated pieces.",
  "properties": {
    "body": {
      "description": "Editorial body as Markpub markdown (legacy plain string accepted on read during migration).",
      "refs": [
        "at.markpub.markdown"
      ],
      "type": "union"
    },
    "title": {
      "maxLength": 160,
      "type": "string"
    }
  },
  "type": "object"
}
item object

No description available.

Properties

document string at-uri Required

AT URI of an included site.standard.document.

note union Optional

Optional Markpub markdown note shown ahead of the piece (legacy plain string accepted on read during migration).

Known types:
View raw schema 
{
  "properties": {
    "document": {
      "description": "AT URI of an included site.standard.document.",
      "format": "at-uri",
      "type": "string"
    },
    "note": {
      "description": "Optional Markpub markdown note shown ahead of the piece (legacy plain string accepted on read during migration).",
      "refs": [
        "at.markpub.markdown"
      ],
      "type": "union"
    }
  },
  "required": [
    "document"
  ],
  "type": "object"
}

Lexicon Garden

@