Link schema
The variant for a link (a CID), which can name the type it expects to point at.

Extends · closed

A variant of the — one of the shapes a schema is allowed to take.
type
Always the link core type.
link
target
The schema the linked block is expected to conform to. Advisory: a validator does not dereference the link.
optional
description
What the link is for, when it is written inline; a published schema is described by its page.
optional
params
Type parameters that make this schema generic, each with its default schema.
⟨ * : ⟩optional
name
Legacy: a name some published schemas still carry. New schemas are named by their page.
optional

A link schema types a CID that points at a separate block. The optional target names the schema the linked block should conform to. The target is advisory: a validator does not fetch the linked block to check it. References and naming compares links with includes.

This document describes the schema/link-schema type, one variant of the meta-schema. Its formal schema is attached as the schemaDefinition in this document's metadata, so the app can show it and create values of this type. Typed documents explains how that works.

See also

    References and naming: include versus link, and why references are names.

    Link: the link kind.

    CID: the content identifier a link holds.

    Blobs: the content-addressed objects links point at.

    Include schema: embeds a shape where a link points across blocks.

Do you like what you are reading? Subscribe to receive updates.

Unsubscribe anytime