manifest.json is the entry point for a content export. The resource-aware implementation uses kind: shoalrun-content-export, schemaVersion: 1, and a resources array. Earlier whole-page exports use a documents array; rebuild those exports before opening them with the resource client.
Available since 0.1.0-alpha.13.
Bundle fields
These fields describe the complete export and its publication.
| Field | Meaning |
|---|---|
digest |
Revision digest for the bundle manifest |
publicBase |
Root-relative serving mount with a trailing slash |
publication |
One channel, version, and language |
review |
API source-review status and digests |
resources |
Selected pages, sections, and snippet instances |
assets |
Local asset records |
files |
Exported file paths, sizes, and digests |
diagnostics |
Export findings such as external images or static interaction output |
A review status of required identifies a review candidate. Do not serve it as an approved content release.
Resource fields
Each resource has ref, publication, title, summary, type, representations, assets, and externalDependencies. A canonicalUrl or source metadata may also be present.
{
"kind": "section",
"documentId": "guide.billing",
"sectionId": "refunds"
}
This is a section's ref, not a complete manifest. Page references use kind and documentId; snippet-instance references use kind and id. Identity is scoped to the publication. A title or generated filename is not a resource reference.
Representations and links
Each available html or markdown representation declares path, mediaType, bytes, digest, anchors, and links. Paths point to files under the export mount. Anchors map source IDs to exported DOM IDs. Link records distinguish resource, canonical, external, and asset targets; resource links include a typed reference.
A resource's asset list names local dependencies. externalDependencies identifies remote images that were not copied. Distribute NOTICES.txt and any required attribution with the content.
Validate a consumer
Use the content client or validate the manifest before fetching its declared paths. Unknown references and unavailable formats are errors. Check representation bytes and digest against the opened revision. Do not assume that a valid digest makes an untrusted host or its HTML safe.
HTML, Markdown, and agents
The manifest records each representation separately because anchors, links, and rendered bytes can differ. It supplies IDs and revision context without inserting machine labels into ordinary Markdown headings. An agent can select Markdown by a resource reference while an application selects HTML from the same revision.