{}OPF
DocsObject referenceEdit on GitHub

Timeline Event

A single event inside a timeline content payload.

Metadata

Definition

#/$defs/TimelineEvent

Type

object

Source

spec/schemas/opf.schema.json

Fields

FieldTypeReqDescription
whenstringEvent time, date, or sequence label. Use ISO-like values when possible, but human labels are allowed for quarters, eras, and relative milestones.
whatstringyesShort event label.
descriptionstringOptional event detail.

when

Type: string · Optional · Default:

Event time, date, or sequence label. Use ISO-like values when possible, but human labels are allowed for quarters, eras, and relative milestones.

when.json
{
  "when": "2026-01"
}

what

Type: string · Required · Default:

Short event label.

what.json
{
  "what": "Pilot"
}

description

Type: string · Optional · Default:

Optional event detail.

description.json
{
  "description": "Launch with the first operations team."
}