Example · all examples
Minimal
This Roadbook is the smallest valid file: one traveler, one day, two items. It shows the seven fields every file needs at the root — formatVersion, id, name, start, end, members, days — and the four fields every item needs: id, title, type, status.
file minimal.roadbook.json
format 1.2
days 1
items 2
bookings 0
validates ✓ schema + reference validator
⤓ Download minimal.roadbook.json View raw JSON Validate Preview
What this example shows#
Use it as the starting point for a hand-written file or as the reference shape when asking an AI assistant for "just the structure". Everything else in the format — bookings, tickets, people, vehicles, alternatives, checklists — is optional and additive.
Features demonstrated#
Manifest tags: days items — see examples/index.json.
Excerpt#
Abridged — the full file is the reference.
{
"formatVersion": "1.2",
"id": "minimal-example",
"name": "A day in Lille",
"start": "2026-09-05",
"end": "2026-09-05",
"members": [
{
"id": "m1",
"name": "Alex",
"role": "owner",
"kind": "adult"
}
],
"days": [
{
"id": "d1",
"index": 1,
"date": "2026-09-05",
"title": "Old Lille",
"items": [
{
"id": "i1",
"time": "10:00",
"title": "Stroll through Old Lille",
"type": "heritage",
"status": "planned",
"place": "Place du Général-de-Gaulle, Lille"
},
{
"id": "i2",
"time": "12:30",
"title": "Lunch",
"type": "meal",
"status": "planned"
}
]
}
]
}
Use it#
- As a reader test: load the file in your player or importer; it must open without error and unknown fields (if you add some) must survive a round-trip.
- As a writer reference: copy the shapes you need — the specification documents every field and the JSON Schema validates the structure.
- With an AI assistant: hand it the file URL as a shape reference ("produce a Roadbook like minimal.roadbook.json for …"); then validate the output.