us.off-the-clock.defs

off-the-clock.us

Documentation

bookmarkPreview object

What a bookmark's card shows of its page: from the member's own us.off-the-clock.bookmark.preview under the bookmark's key while it is no older than the bookmark's current version (source record), else from the AppView's own cached fetch (source appview). Absent when neither has one.

Properties

description string Optional

No description available.

fetchedAt string datetime Optional

When the page was fetched: the sidecar's createdAt, or the AppView's fetch time.

host string Required

No description available.

maxLength: 512 bytes
image string uri Optional

A signed, expiring URL of the preview's image.

imageAlt string Optional

No description available.

record unknown Optional

The sidecar record itself, for source record.

siteName string Optional

No description available.

source string Required

No description available.

maxLength: 32 bytes
Known values: record, appview
title string Optional

No description available.

url string uri Required

A valid URI.

View raw schema
{
  "description": "What a bookmark's card shows of its page: from the member's own us.off-the-clock.bookmark.preview under the bookmark's key while it is no older than the bookmark's current version (source record), else from the AppView's own cached fetch (source appview). Absent when neither has one.",
  "properties": {
    "description": {
      "type": "string"
    },
    "fetchedAt": {
      "description": "When the page was fetched: the sidecar's createdAt, or the AppView's fetch time.",
      "format": "datetime",
      "type": "string"
    },
    "host": {
      "maxLength": 512,
      "type": "string"
    },
    "image": {
      "description": "A signed, expiring URL of the preview's image.",
      "format": "uri",
      "type": "string"
    },
    "imageAlt": {
      "type": "string"
    },
    "record": {
      "description": "The sidecar record itself, for source record.",
      "type": "unknown"
    },
    "siteName": {
      "type": "string"
    },
    "source": {
      "knownValues": [
        "record",
        "appview"
      ],
      "maxLength": 32,
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url",
    "host",
    "source"
  ],
  "type": "object"
}
bookmarkView object

A community.lexicon.bookmarks.bookmark, with the host of its subject, its tags and the preview its card shows (D47).

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

host string Required

The subject's host, lower-cased, www. kept.

maxLength: 512 bytes
indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

record unknown Required

No description available.

tags array of string Required

The bookmark's tags as written.

uri string at-uri Required

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

View raw schema
{
  "description": "A community.lexicon.bookmarks.bookmark, with the host of its subject, its tags and the preview its card shows (D47).",
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "host": {
      "description": "The subject's host, lower-cased, www. kept.",
      "maxLength": 512,
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "preview": {
      "ref": "#bookmarkPreview",
      "type": "ref"
    },
    "record": {
      "type": "unknown"
    },
    "tags": {
      "description": "The bookmark's tags as written.",
      "items": {
        "maxLength": 320,
        "type": "string"
      },
      "type": "array"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "indexedAt",
    "host",
    "tags"
  ],
  "type": "object"
}
eventView object

A community.lexicon.calendar.event.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

mapUrl string uri Optional

A signed, expiring map of the first ten places, when the AppView has a map provider.

places array of ref#place Optional

The located places, in the order of locations.

record unknown Required

No description available.

rsvpCounts ref #rsvpCounts Required

No description available.

uri string at-uri Required

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

viewerRsvp string Optional

The viewer's own RSVP status, a community.lexicon.calendar.rsvp status token.

viewerRsvpUri string at-uri Optional

The viewer's latest RSVP to the event, so a change updates it in place.

View raw schema
{
  "description": "A community.lexicon.calendar.event.",
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "going": {
      "description": "Up to three members whose latest RSVP is going, oldest first.",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "mapUrl": {
      "description": "A signed, expiring map of the first ten places, when the AppView has a map provider.",
      "format": "uri",
      "type": "string"
    },
    "places": {
      "description": "The located places, in the order of locations.",
      "items": {
        "ref": "#place",
        "type": "ref"
      },
      "type": "array"
    },
    "record": {
      "type": "unknown"
    },
    "rsvpCounts": {
      "ref": "#rsvpCounts",
      "type": "ref"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "viewerRsvp": {
      "description": "The viewer's own RSVP status, a community.lexicon.calendar.rsvp status token.",
      "type": "string"
    },
    "viewerRsvpUri": {
      "description": "The viewer's latest RSVP to the event, so a change updates it in place.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "rsvpCounts",
    "indexedAt"
  ],
  "type": "object"
}
feedInfo object

A feed of one pair as members see it, from its us.off-the-clock.feed.generator record (RD-8).

Properties

default boolean Required

The feed the pair's space record names as defaultFeed.

displayName string Required

No description available.

rkey string record-key Required

A valid record key for AT Protocol repositories.

sort string Required

No description available.

Known values: newest, startsAt
text string Required

No description available.

View raw schema
{
  "description": "A feed of one pair as members see it, from its us.off-the-clock.feed.generator record (RD-8).",
  "properties": {
    "default": {
      "description": "The feed the pair's space record names as defaultFeed.",
      "type": "boolean"
    },
    "displayName": {
      "type": "string"
    },
    "rkey": {
      "format": "record-key",
      "type": "string"
    },
    "sort": {
      "knownValues": [
        "newest",
        "startsAt"
      ],
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "displayName",
    "text",
    "sort",
    "default"
  ],
  "type": "object"
}
notificationView object

Notifications of one kind about one subject within a day, newest first.

Properties

count integer Required

No description available.

minimum: 1
isRead boolean Required

No description available.

kind string Required

No description available.

Known values: like, repost, reply, quote, mention, rsvp, event-status, vote
latestAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema
{
  "description": "Notifications of one kind about one subject within a day, newest first.",
  "properties": {
    "actors": {
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "count": {
      "minimum": 1,
      "type": "integer"
    },
    "isRead": {
      "type": "boolean"
    },
    "kind": {
      "knownValues": [
        "like",
        "repost",
        "reply",
        "quote",
        "mention",
        "rsvp",
        "event-status",
        "vote"
      ],
      "type": "string"
    },
    "latestAt": {
      "format": "datetime",
      "type": "string"
    },
    "subject": {
      "refs": [
        "#postView",
        "#eventView",
        "#rsvpView",
        "#profileView",
        "#recordView",
        "us.off-the-clock.polls.pollView"
      ],
      "type": "union"
    }
  },
  "required": [
    "kind",
    "actors",
    "subject",
    "count",
    "latestAt",
    "isRead"
  ],
  "type": "object"
}
place object

A place a post's text names (a place facet, LEX-41) or an event's located location, as cards and drawers show it.

Properties

latitude string Required

WGS84, a decimal string as written.

longitude string Required

WGS84, a decimal string as written.

name string Required

The label the pin and the list show.

url string uri Optional

The place's identifier link: the OpenStreetMap element, or a Foursquare page.

View raw schema
{
  "description": "A place a post's text names (a place facet, LEX-41) or an event's located location, as cards and drawers show it.",
  "properties": {
    "address": {
      "ref": "community.lexicon.location.address",
      "type": "ref"
    },
    "latitude": {
      "description": "WGS84, a decimal string as written.",
      "type": "string"
    },
    "longitude": {
      "description": "WGS84, a decimal string as written.",
      "type": "string"
    },
    "name": {
      "description": "The label the pin and the list show.",
      "type": "string"
    },
    "url": {
      "description": "The place's identifier link: the OpenStreetMap element, or a Foursquare page.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "name",
    "latitude",
    "longitude"
  ],
  "type": "object"
}
policyView object

A space's current policy (LEX-50, D49): the record, a signed URL of its Markdown body, when it was set, and the viewer's acceptance of this version or of an earlier one.

Properties

accepted boolean Required

No description available.

acceptedAt string datetime Optional

An RFC 3339 formatted timestamp.

bodyUrl string uri Optional

The body blob, served signed and expiring like an image.

cid string cid Required

A content identifier (CID) referencing immutable data.

previousAcceptedAt string datetime Optional

When the viewer accepted an earlier version, if their newest acceptance names one.

record unknown Required

The us.off-the-clock.community.policy record.

setAt string datetime Required

The time in the record's TID.

uri string at-uri Required

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

View raw schema
{
  "description": "A space's current policy (LEX-50, D49): the record, a signed URL of its Markdown body, when it was set, and the viewer's acceptance of this version or of an earlier one.",
  "properties": {
    "accepted": {
      "type": "boolean"
    },
    "acceptedAt": {
      "format": "datetime",
      "type": "string"
    },
    "bodyUrl": {
      "description": "The body blob, served signed and expiring like an image.",
      "format": "uri",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "previousAcceptedAt": {
      "description": "When the viewer accepted an earlier version, if their newest acceptance names one.",
      "format": "datetime",
      "type": "string"
    },
    "record": {
      "description": "The us.off-the-clock.community.policy record.",
      "type": "unknown"
    },
    "setAt": {
      "description": "The time in the record's TID.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "record",
    "setAt",
    "accepted"
  ],
  "type": "object"
}
postView object

An app.bsky.feed.post in a community space, its image URLs signed for that space.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

likeCount integer Optional

No description available.

linked array of ref#publicPostView Optional

The public posts the post links, backfilled from their authors' PDSes, in the order the links appear (D51). A failed or pending backfill is left out, so the link card stands.

mapUrl string uri Optional

A signed, expiring map of the first ten places, when the AppView has a map provider.

places array of ref#place Optional

The places the text names, in text order.

quoteCount integer Optional

No description available.

record unknown Required

No description available.

replyCount integer Optional

No description available.

repostCount integer Optional

No description available.

uri string at-uri Required

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

View raw schema
{
  "description": "An app.bsky.feed.post in a community space, its image URLs signed for that space.",
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "embed": {
      "refs": [
        "app.bsky.embed.images#view",
        "app.bsky.embed.external#view",
        "app.bsky.embed.video#view",
        "us.off-the-clock.embed.defs#videoView",
        "app.bsky.embed.gallery#view",
        "us.off-the-clock.embed.defs#audioView",
        "us.off-the-clock.embed.defs#mixedView",
        "app.bsky.embed.record#view",
        "app.bsky.embed.recordWithMedia#view"
      ],
      "type": "union"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "likeCount": {
      "type": "integer"
    },
    "linked": {
      "description": "The public posts the post links, backfilled from their authors' PDSes, in the order the links appear (D51). A failed or pending backfill is left out, so the link card stands.",
      "items": {
        "ref": "#publicPostView",
        "type": "ref"
      },
      "type": "array"
    },
    "mapUrl": {
      "description": "A signed, expiring map of the first ten places, when the AppView has a map provider.",
      "format": "uri",
      "type": "string"
    },
    "parentAuthor": {
      "description": "For a reply whose parent the viewer can see: the parent's author.",
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "places": {
      "description": "The places the text names, in text order.",
      "items": {
        "ref": "#place",
        "type": "ref"
      },
      "type": "array"
    },
    "quoteCount": {
      "type": "integer"
    },
    "reason": {
      "description": "In a feed: the repost this post appears for.",
      "ref": "app.bsky.feed.defs#reasonRepost",
      "type": "ref"
    },
    "record": {
      "type": "unknown"
    },
    "replyCount": {
      "type": "integer"
    },
    "repostCount": {
      "type": "integer"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "viewer": {
      "ref": "#postViewerState",
      "type": "ref"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "indexedAt"
  ],
  "type": "object"
}
postViewerState object

The viewer's own engagement with a post.

Properties

canQuote boolean Optional

False when the author's postgate turns quoting off, for everyone but the author.

detached array of stringat-uri Optional

For the post's author: the quotes their postgate detaches.

like string at-uri Optional

The viewer's like of the post.

quotingDisabled boolean Optional

For the post's author: whose own postgate turns quoting off.

repost string at-uri Optional

The viewer's repost of the post.

View raw schema
{
  "description": "The viewer's own engagement with a post.",
  "properties": {
    "canQuote": {
      "description": "False when the author's postgate turns quoting off, for everyone but the author.",
      "type": "boolean"
    },
    "detached": {
      "description": "For the post's author: the quotes their postgate detaches.",
      "items": {
        "format": "at-uri",
        "type": "string"
      },
      "type": "array"
    },
    "like": {
      "description": "The viewer's like of the post.",
      "format": "at-uri",
      "type": "string"
    },
    "quotingDisabled": {
      "description": "For the post's author: whose own postgate turns quoting off.",
      "type": "boolean"
    },
    "repost": {
      "description": "The viewer's repost of the post.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "type": "object"
}
profileView object

A member's us.off-the-clock.community.profile; only the handle when they have none.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytes
handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

header string uri Optional

A valid URI.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

record unknown Optional

The us.off-the-clock.community.profile record itself; absent when the member has none.

text string Optional

No description available.

maxLength: 25600 bytes
View raw schema
{
  "description": "A member's us.off-the-clock.community.profile; only the handle when they have none.",
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "maxLength": 640,
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    },
    "header": {
      "format": "uri",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "record": {
      "description": "The us.off-the-clock.community.profile record itself; absent when the member has none.",
      "type": "unknown"
    },
    "text": {
      "maxLength": 25600,
      "type": "string"
    }
  },
  "required": [
    "did",
    "handle"
  ],
  "type": "object"
}
publicAuthor object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

View raw schema
{
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    }
  },
  "required": [
    "did",
    "handle"
  ],
  "type": "object"
}
publicMention object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

View raw schema
{
  "properties": {
    "did": {
      "format": "did",
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    }
  },
  "required": [
    "did",
    "handle"
  ],
  "type": "object"
}
publicPostView object

A public app.bsky.feed.post a member's post links, fetched from its author's PDS alone (D51). A withheld or gone view carries url, provider, status and fetchedAt and nothing of the record.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

fetchedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of string Optional

The record's self-label values.

mentions array of ref#publicMention Optional

The handles the record's mention facets resolve to now.

record unknown Optional

The app.bsky.feed.post as its author's PDS gave it.

status string Required

gone: the PDS has no such record or account; withheld: it carries !no-unauthenticated; failed: five attempts did not fetch it.

uri string at-uri Optional

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

url string uri Required

The link as the member wrote it; for a quoted post, its page on the provider.

View raw schema
{
  "description": "A public app.bsky.feed.post a member's post links, fetched from its author's PDS alone (D51). A withheld or gone view carries url, provider, status and fetchedAt and nothing of the record.",
  "properties": {
    "author": {
      "ref": "#publicAuthor",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "external": {
      "ref": "app.bsky.embed.external#viewExternal",
      "type": "ref"
    },
    "fetchedAt": {
      "format": "datetime",
      "type": "string"
    },
    "images": {
      "description": "The record's images, signed URLs of the AppView's cached copies.",
      "items": {
        "ref": "app.bsky.embed.images#viewImage",
        "type": "ref"
      },
      "type": "array"
    },
    "labels": {
      "description": "The record's self-label values.",
      "items": {
        "maxLength": 128,
        "type": "string"
      },
      "type": "array"
    },
    "mentions": {
      "description": "The handles the record's mention facets resolve to now.",
      "items": {
        "ref": "#publicMention",
        "type": "ref"
      },
      "type": "array"
    },
    "provider": {
      "ref": "#publicProvider",
      "type": "ref"
    },
    "quoted": {
      "description": "The post it quotes, one level down.",
      "ref": "#publicQuotedPostView",
      "type": "ref"
    },
    "record": {
      "description": "The app.bsky.feed.post as its author's PDS gave it.",
      "type": "unknown"
    },
    "status": {
      "description": "gone: the PDS has no such record or account; withheld: it carries !no-unauthenticated; failed: five attempts did not fetch it.",
      "enum": [
        "ok",
        "gone",
        "withheld",
        "failed"
      ],
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "description": "The link as the member wrote it; for a quoted post, its page on the provider.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url",
    "provider",
    "fetchedAt",
    "status"
  ],
  "type": "object"
}
publicProvider object

No description available.

Properties

host string Required

A configured public host, or empty for an at:// link with none configured.

name string Required

No description available.

View raw schema
{
  "properties": {
    "host": {
      "description": "A configured public host, or empty for an at:// link with none configured.",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "host",
    "name"
  ],
  "type": "object"
}
publicQuotedPostView object

The post a #publicPostView quotes: the same, without a quote of its own.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

fetchedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of string Optional

The record's self-label values.

mentions array of ref#publicMention Optional

The handles the record's mention facets resolve to now.

record unknown Optional

The app.bsky.feed.post as its author's PDS gave it.

status string Required

gone: the PDS has no such record or account; withheld: it carries !no-unauthenticated; failed: five attempts did not fetch it.

uri string at-uri Optional

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

url string uri Required

The link as the member wrote it; for a quoted post, its page on the provider.

View raw schema
{
  "description": "The post a #publicPostView quotes: the same, without a quote of its own.",
  "properties": {
    "author": {
      "ref": "#publicAuthor",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "external": {
      "ref": "app.bsky.embed.external#viewExternal",
      "type": "ref"
    },
    "fetchedAt": {
      "format": "datetime",
      "type": "string"
    },
    "images": {
      "description": "The record's images, signed URLs of the AppView's cached copies.",
      "items": {
        "ref": "app.bsky.embed.images#viewImage",
        "type": "ref"
      },
      "type": "array"
    },
    "labels": {
      "description": "The record's self-label values.",
      "items": {
        "maxLength": 128,
        "type": "string"
      },
      "type": "array"
    },
    "mentions": {
      "description": "The handles the record's mention facets resolve to now.",
      "items": {
        "ref": "#publicMention",
        "type": "ref"
      },
      "type": "array"
    },
    "provider": {
      "ref": "#publicProvider",
      "type": "ref"
    },
    "record": {
      "description": "The app.bsky.feed.post as its author's PDS gave it.",
      "type": "unknown"
    },
    "status": {
      "description": "gone: the PDS has no such record or account; withheld: it carries !no-unauthenticated; failed: five attempts did not fetch it.",
      "enum": [
        "ok",
        "gone",
        "withheld",
        "failed"
      ],
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "description": "The link as the member wrote it; for a quoted post, its page on the provider.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url",
    "provider",
    "fetchedAt",
    "status"
  ],
  "type": "object"
}
recordView object

Any record without a view of its own.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

collection string nsid Required

A namespaced identifier (e.g., app.bsky.feed.post).

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

uri string at-uri Required

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

value unknown Required

No description available.

View raw schema
{
  "description": "Any record without a view of its own.",
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "collection": {
      "format": "nsid",
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "value": {
      "type": "unknown"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "collection",
    "value",
    "indexedAt"
  ],
  "type": "object"
}
rsvpCounts object

Each member's latest RSVP, counted by status.

Properties

going integer Required

No description available.

interested integer Required

No description available.

notgoing integer Required

No description available.

View raw schema
{
  "description": "Each member's latest RSVP, counted by status.",
  "properties": {
    "going": {
      "type": "integer"
    },
    "interested": {
      "type": "integer"
    },
    "notgoing": {
      "type": "integer"
    }
  },
  "required": [
    "going",
    "interested",
    "notgoing"
  ],
  "type": "object"
}
rsvpView object

A community.lexicon.calendar.rsvp.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

event union Optional

The event it answers, or the event's tombstone when it is gone.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.

record unknown Required

No description available.

uri string at-uri Required

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

View raw schema
{
  "description": "A community.lexicon.calendar.rsvp.",
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "event": {
      "description": "The event it answers, or the event's tombstone when it is gone.",
      "refs": [
        "#eventView",
        "#tombstoneView"
      ],
      "type": "union"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Labels from the community's admins: on the record, its author, or its blobs. shadow never appears; those records are not shown.",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "record": {
      "type": "unknown"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "indexedAt"
  ],
  "type": "object"
}
spacePolicy object

A space's current policy as listSpaces names it: whether the viewer has accepted this version.

Properties

accepted boolean Required

No description available.

acceptedAt string datetime Optional

When the viewer accepted this version.

cid string cid Required

A content identifier (CID) referencing immutable data.

summary string Required

No description available.

uri string at-uri Required

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

View raw schema
{
  "description": "A space's current policy as listSpaces names it: whether the viewer has accepted this version.",
  "properties": {
    "accepted": {
      "type": "boolean"
    },
    "acceptedAt": {
      "description": "When the viewer accepted this version.",
      "format": "datetime",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "summary",
    "accepted"
  ],
  "type": "object"
}
spaceProfileView object

A space's profile as listSpaces carries it, with signed images (LEX-51, D50).

Properties

avatar string uri Required

A valid URI.

description string Required

No description available.

displayName string Required

No description available.

header string uri Required

A valid URI.

View raw schema
{
  "description": "A space's profile as listSpaces carries it, with signed images (LEX-51, D50).",
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "facets": {
      "items": {
        "ref": "app.bsky.richtext.facet",
        "type": "ref"
      },
      "type": "array"
    },
    "header": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "displayName",
    "description",
    "avatar",
    "header"
  ],
  "type": "object"
}
spaceView object

A registered pair as members see it, from its us.off-the-clock.community.space record (RD-21).

Properties

default boolean Required

The default pair: what D5 and D18 call general.

defaultFeed string record-key Required

A valid record key for AT Protocol repositories.

description string Optional

No description available.

displayName string Required

No description available.

memberCount integer Required

The members holding its content space, the community identity included.

minimum: 0
policy ref #spacePolicy Optional

The space's current policy, when it has one (RD-33).

profile ref #spaceProfileView Optional

The space's profile in the directory, when it has one (RD-34).

tid string tid Required

A pair's TID (D33).

View raw schema
{
  "description": "A registered pair as members see it, from its us.off-the-clock.community.space record (RD-21).",
  "properties": {
    "default": {
      "description": "The default pair: what D5 and D18 call general.",
      "type": "boolean"
    },
    "defaultFeed": {
      "format": "record-key",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "memberCount": {
      "description": "The members holding its content space, the community identity included.",
      "minimum": 0,
      "type": "integer"
    },
    "policy": {
      "description": "The space's current policy, when it has one (RD-33).",
      "ref": "#spacePolicy",
      "type": "ref"
    },
    "profile": {
      "description": "The space's profile in the directory, when it has one (RD-34).",
      "ref": "#spaceProfileView",
      "type": "ref"
    },
    "tid": {
      "description": "A pair's TID (D33).",
      "format": "tid",
      "type": "string"
    }
  },
  "required": [
    "tid",
    "displayName",
    "defaultFeed",
    "default",
    "memberCount"
  ],
  "type": "object"
}
tombstoneView object

A post, event or poll a view refers to that is not there (D46): deleted by its author, or withheld from the viewer or never indexed. It carries nothing of the record but its URI, its collection and, when deleted, the time. It stands as a thread's gone node, a quoted post, an RSVP's event, and getRecord's item for a deleted post with replies or event with RSVPs.

Properties

collection string nsid Required

A namespaced identifier (e.g., app.bsky.feed.post).

deletedAt string datetime Optional

When the AppView saw the deletion; set for deleted only.

reason string Required

deleted: the author deleted it and something still refers to it. unavailable: it is withheld from this viewer or was never indexed; no further reason is given.

uri string at-uri Required

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

View raw schema
{
  "description": "A post, event or poll a view refers to that is not there (D46): deleted by its author, or withheld from the viewer or never indexed. It carries nothing of the record but its URI, its collection and, when deleted, the time. It stands as a thread's gone node, a quoted post, an RSVP's event, and getRecord's item for a deleted post with replies or event with RSVPs.",
  "properties": {
    "collection": {
      "format": "nsid",
      "type": "string"
    },
    "deletedAt": {
      "description": "When the AppView saw the deletion; set for deleted only.",
      "format": "datetime",
      "type": "string"
    },
    "parent": {
      "description": "In a thread only: the node above this one, walked by the stored root when the parent is gone.",
      "refs": [
        "app.bsky.feed.defs#threadViewPost",
        "app.bsky.feed.defs#notFoundPost",
        "#tombstoneView",
        "us.off-the-clock.polls.threadViewPoll"
      ],
      "type": "union"
    },
    "reason": {
      "description": "deleted: the author deleted it and something still refers to it. unavailable: it is withheld from this viewer or was never indexed; no further reason is given.",
      "enum": [
        "deleted",
        "unavailable"
      ],
      "type": "string"
    },
    "replies": {
      "description": "In a thread only, for a deleted anchor: the replies below it.",
      "items": {
        "refs": [
          "app.bsky.feed.defs#threadViewPost",
          "app.bsky.feed.defs#notFoundPost",
          "#tombstoneView"
        ],
        "type": "union"
      },
      "type": "array"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "collection",
    "reason"
  ],
  "type": "object"
}

Lexicon Garden

@