# net.atchan.board

> Published by [atchan.net](https://lexicon.garden/identity/did:plc:vshgahazzq7qwvp2xc6ai27o)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:vshgahazzq7qwvp2xc6ai27o/net.atchan.board)
- [Documentation](https://lexicon.garden/lexicon/did:plc:vshgahazzq7qwvp2xc6ai27o/net.atchan.board/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:vshgahazzq7qwvp2xc6ai27o/net.atchan.board/examples)

## Definitions

### `net.atchan.board`

**Type**: `record`

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.

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `order` | `integer` | Yes | Sort order for board listings |
| `rules` | `string` | Yes | A string of rules that apply to this board. Markdown should be rendered. |
| `title` | `string` | Yes | Human-readable board name |
| `labels` | `array` | Yes | 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` | `integer` | No | Maximum number of replies that keep bumping a thread to the top of the board. Omit for no limit. |
| `createdAt` | `string` (datetime) | Yes |  |
| `description` | `string` | Yes | Short description of the board's topic or purpose |

## Raw Schema

```json
{
  "id": "net.atchan.board",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```