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
{
  "description": "A width:height aspect ratio",
  "properties": {
    "height": {
      "description": "Height component of the ratio",
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "description": "Width component of the ratio",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "width",
    "height"
  ],
  "type": "object"
}
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
{
  "description": "A checkbox block — label content plus a checked flag",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "checked": {
      "description": "True if the checkbox is checked (boolean register, defaults to false)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
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
{
  "description": "A code block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "language": {
      "description": "Language identifier for syntax highlighting (string register, known values: javascript, typescript, python, rust, java, c, c++, c#, go)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "syntaxHighlightingTheme": {
      "description": "Optional theme hint (string register)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "text": {
      "description": "The code content as a text sequence",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
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
{
  "description": "A comment block",
  "properties": {
    "author": {
      "description": "The DID of the comment author",
      "format": "did",
      "type": "string"
    },
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "body": {
      "description": "Comment body as a child block id",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "reactions": {
      "description": "Emoji reactions on the comment (set of #reaction)",
      "ref": "page.corvus.core#set",
      "type": "ref"
    },
    "resolved": {
      "description": "True if the comment is resolved (boolean register, defaults to false)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "responseTo": {
      "closed": true,
      "description": "The content this comment is a response to",
      "refs": [
        "#commentBlockReference",
        "#commentSequenceReference",
        "#commentRegisterReference",
        "#commentOrSetReference"
      ],
      "type": "union"
    }
  },
  "required": [
    "blockId",
    "author"
  ],
  "type": "object"
}
commentBlockReference object

A reference to a comment block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "description": "A reference to a comment block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
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
{
  "description": "A reference to a comment OR-set",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "orSet": {
      "description": "The OR-set of the comment reference",
      "type": "string"
    },
    "valueOp": {
      "description": "The operation id of the referenced value",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "orSet",
    "valueOp"
  ],
  "type": "object"
}
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
{
  "description": "A reference to a comment register",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "register": {
      "description": "The register of the comment reference",
      "type": "string"
    },
    "valueOp": {
      "description": "The operation id of the referenced value",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "register",
    "valueOp"
  ],
  "type": "object"
}
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
{
  "description": "A reference to a comment sequence",
  "properties": {
    "atomEnd": {
      "description": "The end atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`",
      "type": "string"
    },
    "atomStart": {
      "description": "The start atom id of the comment reference (inclusive) - formatted as `operationId.atomIdx`",
      "type": "string"
    },
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "sequence": {
      "description": "The sequence of the comment reference",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "sequence",
    "atomStart",
    "atomEnd"
  ],
  "type": "object"
}
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
{
  "description": "An image block",
  "properties": {
    "alt": {
      "description": "Accessibility text describing the image (string register)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "aspectRatio": {
      "description": "The aspect ratio of the image (register of #aspectRatio)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "image": {
      "description": "The image blob",
      "mimeType": "image/*",
      "type": "blob"
    }
  },
  "required": [
    "blockId",
    "image"
  ],
  "type": "object"
}
option object

An option for a select block

Properties

blockId string at-uri Required

The AT-URI of this block record

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

A plain text block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema
{
  "description": "A plain text block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "text": {
      "description": "The text content as a text sequence",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
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
{
  "description": "An emoji reaction with its author",
  "properties": {
    "author": {
      "description": "The DID of the reaction author",
      "format": "did",
      "type": "string"
    },
    "emoji": {
      "description": "The emoji or short string of the reaction",
      "type": "string"
    }
  },
  "required": [
    "emoji",
    "author"
  ],
  "type": "object"
}
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
{
  "description": "A select block — a set of options with one or more selected",
  "properties": {
    "allowMultiple": {
      "description": "True if multiple options can be selected (boolean register, defaults to false)",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "options": {
      "description": "The set of option block ids (set of #option)",
      "ref": "page.corvus.core#set",
      "type": "ref"
    },
    "selected": {
      "description": "The set of selected option block ids",
      "ref": "page.corvus.core#set",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
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
{
  "description": "A tagged block — a set of string tags with an optional allowlist",
  "properties": {
    "allowed": {
      "description": "Optional allowlist of permitted tag strings",
      "ref": "page.corvus.core#set",
      "type": "ref"
    },
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "values": {
      "description": "The set of tag strings",
      "ref": "page.corvus.core#set",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}

Lexicon Garden

@