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

Lexicon Garden

@