blue.catbird.circle.defs

catbird.blue

Documentation

circleSummary object

No description available.

Properties

circleId string tid Required

Stable Circle identity, independent of the Space key, so a Circle remains recognizable across a Space migration.

memberCount integer Optional

Number of members on the owner's PDS member list. The member list itself is owner-only and is read from the owner's PDS, not from this service.

minimum: 0
muted boolean Optional

No description available.

name string Required

No description available.

maxLength: 64 bytesminLength: 1 bytes
owner string did Required

A decentralized identifier (DID).

uri string space-ref Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "circleId",
    "name",
    "owner"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "space-ref"
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1
    },
    "muted": {
      "type": "boolean"
    },
    "owner": {
      "type": "string",
      "format": "did"
    },
    "circleId": {
      "type": "string",
      "format": "tid",
      "description": "Stable Circle identity, independent of the Space key, so a Circle remains recognizable across a Space migration."
    },
    "memberCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of members on the owner's PDS member list. The member list itself is owner-only and is read from the owner's PDS, not from this service."
    }
  }
}
feedItem object

No description available.

Properties

View raw schema
{
  "type": "object",
  "required": [
    "post",
    "circle"
  ],
  "properties": {
    "post": {
      "ref": "app.bsky.feed.defs#feedViewPost",
      "type": "ref"
    },
    "circle": {
      "ref": "#circleSummary",
      "type": "ref"
    }
  }
}
notification object

No description available.

Properties

id string Required

Canonical lowercase hyphenated RFC 4122 UUID.

maxLength: 36 bytesminLength: 36 bytes
indexedAt string datetime Required

An RFC 3339 formatted timestamp.

reason string Required

No description available.

subject string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "reason",
    "actor",
    "indexedAt",
    "circle"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 36,
      "minLength": 36,
      "description": "Canonical lowercase hyphenated RFC 4122 UUID."
    },
    "actor": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "circle": {
      "ref": "#circleSummary",
      "type": "ref"
    },
    "reason": {
      "enum": [
        "reply",
        "like",
        "invite"
      ],
      "type": "string"
    },
    "subject": {
      "type": "string",
      "format": "at-uri"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

Lexicon Garden

@