net.asadaame5121.at-circle.ring Documentation (EN)

main record

An at-circle group definition

Record Key tid Timestamp-based ID

Properties

acceptancePolicy string Optional

How new members are accepted

maxLength: 64 bytes

Known values: automatic, manual

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Description of the circle

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes

status string Required

Recruitment status

maxLength: 64 bytes

Known values: open, closed

title string Required

Name of the circle

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "createdAt",
      "status"
    ],
    "properties": {
      "title": {
        "type": "string",
        "maxLength": 1000,
        "description": "Name of the circle",
        "maxGraphemes": 100
      },
      "status": {
        "type": "string",
        "maxLength": 64,
        "description": "Recruitment status",
        "knownValues": [
          "open",
          "closed"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string",
        "maxLength": 10000,
        "description": "Description of the circle",
        "maxGraphemes": 1000
      },
      "acceptancePolicy": {
        "type": "string",
        "maxLength": 64,
        "description": "How new members are accepted",
        "knownValues": [
          "automatic",
          "manual"
        ]
      }
    }
  },
  "description": "An at-circle group definition"
}