app.offprint.component Documentation (EN)

main record

No description available.

Record Key tid Timestamp-based ID

Properties

content ref app.offprint.content Required

Component body. Same block format as documents.

name string Required

Label to identify this component in the dashboard (e.g. "Newsletter footer").

maxGraphemes: 200 graphemes

publication string at-uri Required

Required AT-URI to the `site.standard.publication` this component belongs to.

updatedAt string datetime Optional

Last edit timestamp.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "publication",
      "name",
      "content"
    ],
    "properties": {
      "name": {
        "type": "string",
        "description": "Label to identify this component in the dashboard (e.g. \"Newsletter footer\").",
        "maxGraphemes": 200
      },
      "content": {
        "ref": "app.offprint.content",
        "type": "ref",
        "description": "Component body. Same block format as documents."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Last edit timestamp."
      },
      "publication": {
        "type": "string",
        "format": "at-uri",
        "description": "Required AT-URI to the `site.standard.publication` this component belongs to."
      }
    }
  }
}