Declares a board available on this atchan service. Published from the service's own identity as the canonical board registry. The record key is the board's identifier.
Record Key
any
Any valid record key
Properties
bumpLimit
integer
Optional
Maximum number of replies that keep bumping a thread to the top of the board. Omit for no limit.
minimum: 1createdAt
string
datetime
Required
An RFC 3339 formatted timestamp.
description
string
Required
Short description of the board's topic or purpose
maxLength: 5000 bytesmaxGraphemes: 500 graphemeslabels
array
of
string
Required
List of labels applied to this board. Client decides how to interpret them. Some use-cases are to enable specific themes, tag a board as NSFW or an authenticated-only visibility.
order
integer
Required
Sort order for board listings
rules
string
Required
A string of rules that apply to this board. Markdown should be rendered.
maxLength: 20000 bytesmaxGraphemes: 2000 graphemestitle
string
Required
Human-readable board name
maxLength: 640 bytesmaxGraphemes: 64 graphemesView raw schema
{
"key": "any",
"type": "record",
"record": {
"type": "object",
"required": [
"title",
"description",
"labels",
"rules",
"order",
"createdAt"
],
"properties": {
"order": {
"type": "integer",
"description": "Sort order for board listings"
},
"rules": {
"type": "string",
"maxLength": 20000,
"description": "A string of rules that apply to this board. Markdown should be rendered.",
"maxGraphemes": 2000
},
"title": {
"type": "string",
"maxLength": 640,
"description": "Human-readable board name",
"maxGraphemes": 64
},
"labels": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"maxGraphemes": 20
},
"description": "List of labels applied to this board. Client decides how to interpret them. Some use-cases are to enable specific themes, tag a board as NSFW or an authenticated-only visibility."
},
"bumpLimit": {
"type": "integer",
"minimum": 1,
"description": "Maximum number of replies that keep bumping a thread to the top of the board. Omit for no limit."
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "Short description of the board's topic or purpose",
"maxGraphemes": 500
}
}
},
"description": "Declares a board available on this atchan service. Published from the service's own identity as the canonical board registry. The record key is the board's identifier."
}