Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Code API reference

ContentManifest

One validated, content-addressed export inventory.

Updated
Read as Markdown

Type shoalrun.content.ContentManifest

type ContentManifest = {
    schemaVersion: 1 | 2;
    kind: 'shoalrun-content-export';
    digest: string;
    publicBase: string;
    publication: ContentPublication;
    review: {
        status: 'ok' | 'required';
        apis: Array<{
            apiId: string;
            digest: string;
        }>;
    };
    resources: ContentResource[];
    assets: ContentAsset[];
    files: ContentFile[];
    diagnostics: Array<{
        code: string;
        documentId?: string;
        message: string;
    }>;
};

One validated, content-addressed export inventory.

Fields

Name Type Required / default Description
assets ContentAsset[] Required —
diagnostics { code: string; documentId?: string; message: string; }[] Required —
digest string Required —
files ContentFile[] Required —
kind "shoalrun-content-export" Required —
publicBase string Required —
publication ContentPublication Required —
resources ContentResource[] Required —
review { status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; } Required —
schemaVersion 1 | 2 Required —

shoalrun.content.ContentManifest.assets

Property shoalrun.content.ContentManifest.assets

assets: ContentAsset[]

Type: ContentAsset[]

Required

shoalrun.content.ContentManifest.diagnostics

Property shoalrun.content.ContentManifest.diagnostics

diagnostics: { code: string; documentId?: string; message: string; }[]

Type: { code: string; documentId?: string; message: string; }[]

Required

shoalrun.content.ContentManifest.digest

Property shoalrun.content.ContentManifest.digest

digest: string

Type: string

Required

shoalrun.content.ContentManifest.files

Property shoalrun.content.ContentManifest.files

files: ContentFile[]

Type: ContentFile[]

Required

shoalrun.content.ContentManifest.kind

Property shoalrun.content.ContentManifest.kind

kind: "shoalrun-content-export"

Type: "shoalrun-content-export"

Required

shoalrun.content.ContentManifest.publicBase

Property shoalrun.content.ContentManifest.publicBase

publicBase: string

Type: string

Required

shoalrun.content.ContentManifest.publication

Property shoalrun.content.ContentManifest.publication

publication: ContentPublication

Type: ContentPublication

Required

shoalrun.content.ContentManifest.resources

Property shoalrun.content.ContentManifest.resources

resources: ContentResource[]

Type: ContentResource[]

Required

shoalrun.content.ContentManifest.review

Property shoalrun.content.ContentManifest.review

review: { status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }

Type: { status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }

Required

shoalrun.content.ContentManifest.schemaVersion

Property shoalrun.content.ContentManifest.schemaVersion

schemaVersion: 1 | 2

Type: 1 | 2

Required