Misc schema — API Protocol property reference Misc schemas of the ObjectStack API Protocol: ResolvedBook, ResolvedEntry, ResolvedGroup — each property with its type, default and a TypeScript example.
import { ResolvedBookSchema, ResolvedEntrySchema, ResolvedGroupSchema } from '@objectstack/spec/api' ; import type { ResolvedBook, ResolvedEntry, ResolvedGroup } from '@objectstack/spec/api' ; // Validate data const result = ResolvedBookSchema. parse (data); Property Type Required Description name string✅ The book's machine name. label stringoptional The book's display label, when it declares one. groups { key: string; label: string; entries: object[] }[]✅ The resolved groups, in render order.
Property Type Required Description key string✅ The group's key (from the spine, or uncategorized). label string✅ The group's display label. entries { doc?: string; href?: string; label?: string; description?: string; … }[]✅ The group's resolved entries, in render order.
Property Type Required Description doc stringoptional Doc name, or undefined for an external link / separator. href stringoptional External link target, when the entry is a link. label stringoptional Display label, when one resolved. description stringoptional Doc description, when one resolved. badge stringoptional Badge text (e.g. "beta"), when declared. icon stringoptional Icon name, when declared. separator booleanoptional True for a --- separator node.
Property Type Required Description key string✅ The group's key (from the spine, or uncategorized). label string✅ The group's display label. entries { doc?: string; href?: string; label?: string; description?: string; … }[]✅ The group's resolved entries, in render order.
Property Type Required Description doc stringoptional Doc name, or undefined for an external link / separator. href stringoptional External link target, when the entry is a link. label stringoptional Display label, when one resolved. description stringoptional Doc description, when one resolved. badge stringoptional Badge text (e.g. "beta"), when declared. icon stringoptional Icon name, when declared. separator booleanoptional True for a --- separator node.
ObjectStack