com.getorbyt.community.defs

getorbyt.com

Documentation

feedItem object

No description available.

Properties

pinned boolean Optional

No description available.

post string at-uri Required

The linked app.bsky.feed.post URI. Clients hydrate it through their authenticated Bluesky AppView.

removedAt string datetime Optional

An RFC 3339 formatted timestamp.

removedBy string did Optional

A decentralized identifier (DID).

removedReason string Optional

Present only for the post author and Community moderators.

maxLength: 1000 bytes
status string Optional

Community-level state; absent means visible. `removed` is a moderator removal scoped to this Community; the underlying app.bsky.feed.post remains live on the network. Only the author and Community moderators receive removed items.

Known values: visible, removed
View raw schema
{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "type": "string",
      "format": "at-uri",
      "description": "The linked app.bsky.feed.post URI. Clients hydrate it through their authenticated Bluesky AppView."
    },
    "pinned": {
      "type": "boolean",
      "default": false
    },
    "status": {
      "type": "string",
      "description": "Community-level state; absent means visible. `removed` is a moderator removal scoped to this Community; the underlying app.bsky.feed.post remains live on the network. Only the author and Community moderators receive removed items.",
      "knownValues": [
        "visible",
        "removed"
      ]
    },
    "removedAt": {
      "type": "string",
      "format": "datetime"
    },
    "removedBy": {
      "type": "string",
      "format": "did"
    },
    "removedReason": {
      "type": "string",
      "maxLength": 1000,
      "description": "Present only for the post author and Community moderators."
    }
  }
}
memberView object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

joinedAt string datetime Optional

An RFC 3339 formatted timestamp.

membershipUri string at-uri Optional

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

role string Optional

Absent means member.

Known values: owner, moderator, member
status string Optional

Absent means active.

Known values: active, muted, banned
View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "role": {
      "type": "string",
      "description": "Absent means member.",
      "knownValues": [
        "owner",
        "moderator",
        "member"
      ]
    },
    "status": {
      "type": "string",
      "description": "Absent means active.",
      "knownValues": [
        "active",
        "muted",
        "banned"
      ]
    },
    "joinedAt": {
      "type": "string",
      "format": "datetime"
    },
    "membershipUri": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
rule object

One Community rule. An object rather than a bare string so a title, an ordinal or a createdAt can be added later without a schema break.

Properties

text string Required

No description available.

maxLength: 500 bytes
View raw schema
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 500
    }
  },
  "description": "One Community rule. An object rather than a bare string so a title, an ordinal or a createdAt can be added later without a schema break."
}
view object

A hydrated Community. Only the fields that identify the Community are required; counts and viewer state are optional so a cheaper view can omit them without a schema break.

Properties

accentColor string Optional

No description available.

maxLength: 32 bytes
avatar string uri Optional

A valid URI.

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 2000 bytes
labels array of refcom.atproto.label.defs#label Optional

Labels applied to this Community. Clients moderate against these exactly as they do app.bsky.feed.defs#postView labels.

memberCount integer Optional

No description available.

minimum: 0
name string Required

No description available.

maxLength: 63 bytesminLength: 2 bytes
ownerDid string did Required

The account whose repository holds the Community declaration record. Clients hydrate it to a profile through their authenticated Bluesky AppView.

postCount integer Optional

No description available.

minimum: 0
postPolicy string Optional

The raw value its owner wrote, not the value this service resolved. Absent means anyone, which is also how a server that predates this field behaves.

Known values: anyone, members, moderators
rules array of ref#rule Optional

No description available.

maxLength: 20 items
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

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

viewer ref #viewerState Optional

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "name",
    "ownerDid",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string",
      "maxLength": 63,
      "minLength": 2
    },
    "rules": {
      "type": "array",
      "items": {
        "ref": "#rule",
        "type": "ref"
      },
      "maxLength": 20
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "description": "Labels applied to this Community. Clients moderate against these exactly as they do app.bsky.feed.defs#postView labels."
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "ownerDid": {
      "type": "string",
      "format": "did",
      "description": "The account whose repository holds the Community declaration record. Clients hydrate it to a profile through their authenticated Bluesky AppView."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "postCount": {
      "type": "integer",
      "minimum": 0
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "postPolicy": {
      "type": "string",
      "description": "The raw value its owner wrote, not the value this service resolved. Absent means anyone, which is also how a server that predates this field behaves.",
      "knownValues": [
        "anyone",
        "members",
        "moderators"
      ]
    },
    "accentColor": {
      "type": "string",
      "maxLength": 32
    },
    "description": {
      "type": "string",
      "maxLength": 2000
    },
    "memberCount": {
      "type": "integer",
      "minimum": 0
    }
  },
  "description": "A hydrated Community. Only the fields that identify the Community are required; counts and viewer state are optional so a cheaper view can omit them without a schema break."
}
viewerState object

The requesting account's relationship to a Community. Every field is optional; an absent field means the viewer holds no membership and no privilege.

Properties

canManage boolean Optional

No description available.

canModerate boolean Optional

No description available.

canPost boolean Optional

No description available.

membershipStatus string Optional

Absent means none.

Known values: none, active, muted, banned
membershipUri string at-uri Optional

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

role string Optional

No description available.

Known values: owner, moderator, member
View raw schema
{
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "knownValues": [
        "owner",
        "moderator",
        "member"
      ]
    },
    "canPost": {
      "type": "boolean",
      "default": false
    },
    "canManage": {
      "type": "boolean",
      "default": false
    },
    "canModerate": {
      "type": "boolean",
      "default": false
    },
    "membershipUri": {
      "type": "string",
      "format": "at-uri"
    },
    "membershipStatus": {
      "type": "string",
      "description": "Absent means none.",
      "knownValues": [
        "none",
        "active",
        "muted",
        "banned"
      ]
    }
  },
  "description": "The requesting account's relationship to a Community. Every field is optional; an absent field means the viewer holds no membership and no privilege."
}
writeStatus object

The fate of one record the caller wrote to their own repository.

Properties

error string Optional

Why the record was rejected. Present only for `rejected`.

maxLength: 1000 bytes
indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

status string Required

`pending` means the record has not reached this service yet, which is the normal state for a few seconds after a write. `rejected` means it will never be indexed as written.

Known values: indexed, pending, rejected, deleted
uri string at-uri Required

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

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "status"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "error": {
      "type": "string",
      "maxLength": 1000,
      "description": "Why the record was rejected. Present only for `rejected`."
    },
    "status": {
      "type": "string",
      "description": "`pending` means the record has not reached this service yet, which is the normal state for a few seconds after a write. `rejected` means it will never be indexed as written.",
      "knownValues": [
        "indexed",
        "pending",
        "rejected",
        "deleted"
      ]
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "The fate of one record the caller wrote to their own repository."
}

Lexicon Garden

@