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

ContentRestResource

Revision-scoped metadata envelope for a single content resource.

Updated
Read as Markdown

Type shoalrun.content.ContentRestResource

type ContentRestResource = {
    schemaVersion: 1 | 2;
    revision: string;
    publication: ContentPublication;
    key: string;
    resource: ContentResource;
};

Revision-scoped metadata envelope for a single content resource.

Fields

Name Type Required / default Description
key string Required —
publication ContentPublication Required —
resource ContentResource Required —
revision string Required —
schemaVersion 1 | 2 Required —

shoalrun.content.ContentRestResource.key

Property shoalrun.content.ContentRestResource.key

key: string

Type: string

Required

shoalrun.content.ContentRestResource.publication

Property shoalrun.content.ContentRestResource.publication

publication: ContentPublication

Type: ContentPublication

Required

shoalrun.content.ContentRestResource.resource

Property shoalrun.content.ContentRestResource.resource

resource: ContentResource

Type: ContentResource

Required

shoalrun.content.ContentRestResource.revision

Property shoalrun.content.ContentRestResource.revision

revision: string

Type: string

Required

shoalrun.content.ContentRestResource.schemaVersion

Property shoalrun.content.ContentRestResource.schemaVersion

schemaVersion: 1 | 2

Type: 1 | 2

Required