Catalog Index
Generic shape shared by every spec/catalogs/<kind>/index.json file in the OPF repo. An index is a lightweight, ordered summary of the full-record JSON files that live alongside it: each entry names the record'…
Schema $id
https://openpresentation.org/schema/opf-catalog-index/v1
Source
spec/schemas/catalog-index.schema.json
Field index
| Field | Type | Req | Default | Description |
|---|---|---|---|---|
| $schema | const | yes | — | |
| version | string | yes | — | Index format version, as a string. |
| description | string | yes | — | Human-readable description of what this catalog kind holds and how entries are ordered. |
| records | array<ref:IndexRecord> | yes | — | Ordered list of lightweight record summaries. Order defines the catalog's canonical/display order; full record data lives in the sibling JSON file named by file. |
$schema
Type: const · Required · Default: —
{
"$schema": "https://openpresentation.org/schema/opf-catalog-index/v1"
}version
Type: string · Required · Default: —
Index format version, as a string.
{
"version": "1"
}description
Type: string · Required · Default: —
Human-readable description of what this catalog kind holds and how entries are ordered.
{
"description": "description-value"
}records
Type: array<ref:IndexRecord> · Required · Default: —
Ordered list of lightweight record summaries. Order defines the catalog's canonical/display order; full record data lives in the sibling JSON file named by file.
{
"records": []
}