fyi.opensocial.role Documentation (EN)

main record

Declares that a role exists. The record key is the role id.

Record Key any Any valid record key

Properties

bot boolean Optional

People with this role are bots: accounts that act on their own, not a person. A member is a bot if any of their roles says so.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

name string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

View raw schema

{
  "description": "Declares that a role exists. The record key is the role id.",
  "key": "any",
  "record": {
    "properties": {
      "bot": {
        "description": "People with this role are bots: accounts that act on their own, not a person. A member is a bot if any of their roles says so.",
        "type": "boolean"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "name": {
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      }
    },
    "required": [
      "name",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}