ContentResource

Type shoalrun.content.ContentResource

type ContentResource = {
    ref: ContentRef;
    publication: ContentPublication;
    title: string;
    summary: string;
    type: string;
    canonicalUrl?: string;
    source?: {
        documentId?: string;
        snippetId?: string;
        valuesDigest?: string;
    };
    representations: Partial<Record<ContentFormat, ContentRepresentation>>;
    assets: string[];
    externalDependencies: Array<{
        url: string;
        kind: 'image';
    }>;
};

Inventory entry describing one exported document, section, or snippet instance.

Fields

Name	Type	Required / default	Description
`assets`	`string[]`	Required	—
`canonicalUrl`	`string \| undefined`	Optional	—
`externalDependencies`	`{ url: string; kind: "image"; }[]`	Required	—
`publication`	`ContentPublication`	Required	Exact product, channel, version, and documentation language.
`ref`	`ContentRef`	Required	Stable identity used by ContentSnapshot.get.
`representations`	`Partial<Record<ContentFormat,` `ContentRepresentation>>`	Required	Available portable formats and their files, anchors, and typed links.
`source`	`{ documentId?: string; snippetId?: string; valuesDigest?: string; } \| undefined`	Optional	—
`summary`	`string`	Required	Short explanation of the resource's purpose.
`title`	`string`	Required	Human-readable resource title.
`type`	`string`	Required	Authored document type, or section/snippet for a selected resource.

shoalrun.content.ContentResource.assets

Property shoalrun.content.ContentResource.assets

assets: string[]

Type: string[]

Required

shoalrun.content.ContentResource.canonicalUrl

Property shoalrun.content.ContentResource.canonicalUrl

canonicalUrl?: string | undefined

Type: string | undefined

Optional

shoalrun.content.ContentResource.externalDependencies

Property shoalrun.content.ContentResource.externalDependencies

externalDependencies: { url: string; kind: "image"; }[]

Type: { url: string; kind: "image"; }[]

Required

shoalrun.content.ContentResource.publication

Property shoalrun.content.ContentResource.publication

publication: ContentPublication

Exact product, channel, version, and documentation language.

Type: ContentPublication

Required

shoalrun.content.ContentResource.ref

Property shoalrun.content.ContentResource.ref

ref: ContentRef

Stable identity used by ContentSnapshot.get.

Type: ContentRef

Required

shoalrun.content.ContentResource.representations

Property shoalrun.content.ContentResource.representations

representations: Partial<Record<ContentFormat, ContentRepresentation>>

Available portable formats and their files, anchors, and typed links.

Type: Partial<Record<ContentFormat, ContentRepresentation>>

Required

shoalrun.content.ContentResource.source

Property shoalrun.content.ContentResource.source

source?: { documentId?: string; snippetId?: string; valuesDigest?: string; } | undefined

Type: { documentId?: string; snippetId?: string; valuesDigest?: string; } | undefined

Optional

shoalrun.content.ContentResource.summary

Property shoalrun.content.ContentResource.summary

summary: string

Short explanation of the resource's purpose.

Type: string

Required

shoalrun.content.ContentResource.title

Property shoalrun.content.ContentResource.title

title: string

Human-readable resource title.

Type: string

Required

shoalrun.content.ContentResource.type

Property shoalrun.content.ContentResource.type

type: string

Authored document type, or section/snippet for a selected resource.

Type: string

Required