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

ContentRestList

Revision-scoped inventory envelope returned by the content REST service.

Updated
Read as Markdown

Type shoalrun.content.ContentRestList

type ContentRestList = {
    schemaVersion: 1 | 2;
    revision: string;
    publication: ContentPublication;
    resources: ContentRestEntry[];
};

Revision-scoped inventory envelope returned by the content REST service.

Fields

Name Type Required / default Description
publication ContentPublication Required —
resources ContentRestEntry[] Required —
revision string Required —
schemaVersion 1 | 2 Required —

shoalrun.content.ContentRestList.publication

Property shoalrun.content.ContentRestList.publication

publication: ContentPublication

Type: ContentPublication

Required

shoalrun.content.ContentRestList.resources

Property shoalrun.content.ContentRestList.resources

resources: ContentRestEntry[]

Type: ContentRestEntry[]

Required

shoalrun.content.ContentRestList.revision

Property shoalrun.content.ContentRestList.revision

revision: string

Type: string

Required

shoalrun.content.ContentRestList.schemaVersion

Property shoalrun.content.ContentRestList.schemaVersion

schemaVersion: 1 | 2

Type: 1 | 2

Required