social.colibri.beta.category Documentation (EN)

main record

A named group of channels within a community.

Record Key tid Timestamp-based ID

Properties

channelOrder array of string record-key Required

The channels in this category, in display order, by space key.

name string Required

The category's name.

maxLength: 32 bytesminLength: 1 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "channelOrder"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 32,
        "minLength": 1,
        "description": "The category's name."
      },
      "channelOrder": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "record-key",
          "description": "The space key of a channel in this category."
        },
        "description": "The channels in this category, in display order, by space key."
      }
    }
  },
  "description": "A named group of channels within a community."
}