social.colibri.category

colibri.social

Documentation

A category belongs to a community and contains multiple channels on Colibri.

main record

A category belongs to a community and contains multiple channels on Colibri.

Record Key tid Timestamp-based ID

Properties

$type string nsid Optional

The type of the record.

channelOrder array of string record-key Required

The order of the channels in this category.

community string record-key Required

The community this category belongs to.

name string Required

The name of the category.

maxLength: 32 bytesminLength: 1 bytes
Default: New category
View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "channelOrder",
      "community"
    ],
    "properties": {
      "name": {
        "type": "string",
        "default": "New category",
        "maxLength": 32,
        "minLength": 1,
        "description": "The name of the category."
      },
      "$type": {
        "type": "string",
        "format": "nsid",
        "description": "The type of the record."
      },
      "community": {
        "type": "string",
        "format": "record-key",
        "description": "The community this category belongs to."
      },
      "channelOrder": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "record-key",
          "description": "A channel in this category."
        },
        "description": "The order of the channels in this category."
      }
    }
  },
  "description": "A category belongs to a community and contains multiple channels on Colibri."
}

Lexicon Garden

@