social.colibri.beta.community.settings

colibri.social

Documentation

A community's operational settings. Separate from the profile record so the two have different read audiences.

main record

A community's operational settings. Separate from the profile record so the two have different read audiences.

Record Key literal:self Fixed literal value

Properties

categoryOrder array of string record-key Required

The order categories are displayed in.

labelers array of string did Optional

DIDs whose labels this community honours, in addition to the community's own. Empty means the community labels its content itself.

linkEmbeds boolean Optional

Whether link previews are shown by default. Channels may override this.

Default: true
requiresApprovalToJoin boolean Required

Whether joining produces an application a moderator must approve.

Default: false
View raw schema
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "categoryOrder",
      "requiresApprovalToJoin"
    ],
    "properties": {
      "labelers": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did",
          "description": "A labeler this community honours."
        },
        "description": "DIDs whose labels this community honours, in addition to the community's own. Empty means the community labels its content itself."
      },
      "linkEmbeds": {
        "type": "boolean",
        "default": true,
        "description": "Whether link previews are shown by default. Channels may override this."
      },
      "categoryOrder": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "record-key",
          "description": "A category in this community."
        },
        "description": "The order categories are displayed in."
      },
      "requiresApprovalToJoin": {
        "type": "boolean",
        "default": false,
        "description": "Whether joining produces an application a moderator must approve."
      }
    }
  },
  "description": "A community's operational settings. Separate from the profile record so the two have different read audiences."
}

Lexicon Garden

@