page.corvus.contentBlocks

corvus.page

Documentation

aspectRatio object

A width:height aspect ratio

Properties

height integer Required

Height component of the ratio

minimum: 1
width integer Required

Width component of the ratio

minimum: 1
View raw schema
{
  "type": "object",
  "required": [
    "width",
    "height"
  ],
  "properties": {
    "width": {
      "type": "integer",
      "minimum": 1,
      "description": "Width component of the ratio"
    },
    "height": {
      "type": "integer",
      "minimum": 1,
      "description": "Height component of the ratio"
    }
  },
  "description": "A width:height aspect ratio"
}
checkbox object

A checkbox block — label content plus a checked flag

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "checked": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "True if the checkbox is checked (boolean register, defaults to false)"
    }
  },
  "description": "A checkbox block — label content plus a checked flag"
}
code object

A code block

Properties

blockId string at-uri Required

The AT-URI of this block record

language ref page.corvus.core#register Optional

Language identifier for syntax highlighting (string register, known values: javascript, typescript, python, rust, java, c, c++, c#, go)

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "text": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "The code content as a text sequence"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "language": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "Language identifier for syntax highlighting (string register, known values: javascript, typescript, python, rust, java, c, c++, c#, go)"
    },
    "syntaxHighlightingTheme": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "Optional theme hint (string register)"
    }
  },
  "description": "A code block"
}
comment object

A comment block

Properties

author string did Required

The DID of the comment author

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "author"
  ],
  "properties": {
    "body": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "Comment body as a child block id"
    },
    "author": {
      "type": "string",
      "format": "did",
      "description": "The DID of the comment author"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "resolved": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "True if the comment is resolved (boolean register, defaults to false)"
    },
    "reactions": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "Emoji reactions on the comment (set of #reaction)"
    },
    "responseTo": {
      "refs": [
        "#commentBlockReference",
        "#commentSequenceReference",
        "#commentRegisterReference",
        "#commentOrSetReference"
      ],
      "type": "union",
      "closed": true,
      "description": "The content this comment is a response to"
    }
  },
  "description": "A comment block"
}
commentBlockReference object

A reference to a comment block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "A reference to a comment block"
}
commentOrSetReference object

A reference to a comment OR-set

Properties

blockId string at-uri Required

The AT-URI of this block record

orSet string Required

The OR-set of the comment reference

valueOp string Required

The operation id of the referenced value

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "orSet",
    "valueOp"
  ],
  "properties": {
    "orSet": {
      "type": "string",
      "description": "The OR-set of the comment reference"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "valueOp": {
      "type": "string",
      "description": "The operation id of the referenced value"
    }
  },
  "description": "A reference to a comment OR-set"
}
commentRegisterReference object

A reference to a comment register

Properties

blockId string at-uri Required

The AT-URI of this block record

register string Required

The register of the comment reference

valueOp string Required

The operation id of the referenced value

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "register",
    "valueOp"
  ],
  "properties": {
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "valueOp": {
      "type": "string",
      "description": "The operation id of the referenced value"
    },
    "register": {
      "type": "string",
      "description": "The register of the comment reference"
    }
  },
  "description": "A reference to a comment register"
}
commentSequenceReference object

A reference to a comment sequence

Properties

atomEnd string Required

The end atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`

atomStart string Required

The start atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`

blockId string at-uri Required

The AT-URI of this block record

sequence string Required

The sequence of the comment reference

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "sequence",
    "atomStart",
    "atomEnd"
  ],
  "properties": {
    "atomEnd": {
      "type": "string",
      "description": "The end atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "sequence": {
      "type": "string",
      "description": "The sequence of the comment reference"
    },
    "atomStart": {
      "type": "string",
      "description": "The start atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`"
    }
  },
  "description": "A reference to a comment sequence"
}
image object

An image block

Properties

blockId string at-uri Required

The AT-URI of this block record

image blob Required

The image blob

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "image"
  ],
  "properties": {
    "alt": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "Accessibility text describing the image (string register)"
    },
    "image": {
      "type": "blob",
      "mimeType": "image/*",
      "description": "The image blob"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "aspectRatio": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "The aspect ratio of the image (register of #aspectRatio)"
    }
  },
  "description": "An image block"
}
option object

An option for a select block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId",
    "label"
  ],
  "properties": {
    "color": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "Optional color hint (string register)"
    },
    "label": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "Display name of the option as a text sequence"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "An option for a select block"
}
plainText object

A plain text block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "text": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "The text content as a text sequence"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "A plain text block"
}
reaction object

An emoji reaction with its author

Properties

author string did Required

The DID of the reaction author

emoji string Required

The emoji or short string of the reaction

View raw schema
{
  "type": "object",
  "required": [
    "emoji",
    "author"
  ],
  "properties": {
    "emoji": {
      "type": "string",
      "description": "The emoji or short string of the reaction"
    },
    "author": {
      "type": "string",
      "format": "did",
      "description": "The DID of the reaction author"
    }
  },
  "description": "An emoji reaction with its author"
}
select object

A select block — a set of options with one or more selected

Properties

allowMultiple ref page.corvus.core#register Optional

True if multiple options can be selected (boolean register, defaults to false)

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "options": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The set of option block ids (set of #option)"
    },
    "selected": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The set of selected option block ids"
    },
    "allowMultiple": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "True if multiple options can be selected (boolean register, defaults to false)"
    }
  },
  "description": "A select block — a set of options with one or more selected"
}
tagged object

A tagged block — a set of string tags with an optional allowlist

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "values": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The set of tag strings"
    },
    "allowed": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "Optional allowlist of permitted tag strings"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "A tagged block — a set of string tags with an optional allowlist"
}

Lexicon Garden

@