social.coves.community.profile

coves.social

Documentation

A community's profile information (V2: stored in community's own repository)

main record

A community's profile information (V2: stored in community's own repository)

Record Key literal:self Fixed literal value

Properties

avatar blob Optional

No description available.

maxSize: 1.0 MB
banner blob Optional

No description available.

maxSize: 2.0 MB
contentWarnings array of string Optional

Required content warnings for this community

createdAt string datetime Required

An RFC 3339 formatted timestamp.

createdBy string did Optional

DID of the user who created this community

description string Optional

Community description with rich text support

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
displayName string Optional

Display name for the community

maxLength: 1280 bytesmaxGraphemes: 128 graphemes
hostedBy string did Optional

DID of the instance hosting this community

moderationType string Optional

Type of moderation system (moderator=traditional moderator team, sortition=community tribunal)

maxLength: 64 bytes
Known values: moderator, sortition
Default: moderator
name string Required

Short community name (local part of handle). Must be a valid DNS label: ASCII letters, digits, and hyphens only.

maxLength: 63 bytes
origin string Optional

Instance this community actually lives on (hostname only, e.g. lemmy.world). Self-asserted; appviews must validate against the verified handle.

maxLength: 253 bytes
visibility string Optional

Community visibility level

maxLength: 64 bytes
Known values: public, unlisted, private
Default: public
View raw schema 
{
  "description": "A community's profile information (V2: stored in community's own repository)",
  "key": "literal:self",
  "record": {
    "properties": {
      "avatar": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 1000000,
        "type": "blob"
      },
      "banner": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 2000000,
        "type": "blob"
      },
      "contentWarnings": {
        "description": "Required content warnings for this community",
        "items": {
          "knownValues": [
            "nsfw",
            "violence",
            "spoilers"
          ],
          "maxLength": 32,
          "type": "string"
        },
        "type": "array"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "createdBy": {
        "description": "DID of the user who created this community",
        "format": "did",
        "type": "string"
      },
      "description": {
        "description": "Community description with rich text support",
        "maxGraphemes": 1000,
        "maxLength": 10000,
        "type": "string"
      },
      "descriptionFacets": {
        "description": "Rich text annotations for description",
        "items": {
          "ref": "social.coves.richtext.facet",
          "type": "ref"
        },
        "type": "array"
      },
      "displayName": {
        "description": "Display name for the community",
        "maxGraphemes": 128,
        "maxLength": 1280,
        "type": "string"
      },
      "hostedBy": {
        "description": "DID of the instance hosting this community",
        "format": "did",
        "type": "string"
      },
      "moderationType": {
        "default": "moderator",
        "description": "Type of moderation system (moderator=traditional moderator team, sortition=community tribunal)",
        "knownValues": [
          "moderator",
          "sortition"
        ],
        "maxLength": 64,
        "type": "string"
      },
      "name": {
        "description": "Short community name (local part of handle). Must be a valid DNS label: ASCII letters, digits, and hyphens only.",
        "maxLength": 63,
        "type": "string"
      },
      "origin": {
        "description": "Instance this community actually lives on (hostname only, e.g. lemmy.world). Self-asserted; appviews must validate against the verified handle.",
        "maxLength": 253,
        "type": "string"
      },
      "visibility": {
        "default": "public",
        "description": "Community visibility level",
        "knownValues": [
          "public",
          "unlisted",
          "private"
        ],
        "maxLength": 64,
        "type": "string"
      }
    },
    "required": [
      "name",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@