us.off-the-clock.admin.defs Documentation (EN)

blob object

A blob records in the space reference.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

did string did Required

A decentralized identifier (DID).

labels array of refus.off-the-clock.admin.defs#label Required

No description available.

mime string Optional

No description available.

records integer Required

No description available.

View raw schema

{
  "description": "A blob records in the space reference.",
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "us.off-the-clock.admin.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "mime": {
      "type": "string"
    },
    "records": {
      "type": "integer"
    }
  },
  "required": [
    "did",
    "cid",
    "records",
    "labels"
  ],
  "type": "object"
}

collectionCount object

No description available.

Properties

collection string nsid Required

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

count integer Required

No description available.

View raw schema

{
  "properties": {
    "collection": {
      "format": "nsid",
      "type": "string"
    },
    "count": {
      "type": "integer"
    }
  },
  "required": [
    "collection",
    "count"
  ],
  "type": "object"
}

feed object

The effective feed of a pair's record key (D13, D36).

Properties

author string did Required

A decentralized identifier (DID).

configuration unknown Required

No description available.

default boolean Required

The feed the pair's space record names.

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": "The effective feed of a pair's record key (D13, D36).",
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "configuration": {
      "type": "unknown"
    },
    "default": {
      "description": "The feed the pair's space record names.",
      "type": "boolean"
    },
    "displayName": {
      "type": "string"
    },
    "rkey": {
      "format": "record-key",
      "type": "string"
    },
    "sort": {
      "knownValues": [
        "newest",
        "startsAt"
      ],
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "author",
    "displayName",
    "text",
    "configuration",
    "sort",
    "default"
  ],
  "type": "object"
}

grant object

One us.off-the-clock.community.membership record.

Properties

author string did Required

A decentralized identifier (DID).

counts boolean Required

Its author is an effective admin, so it grants what it names.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

note string Optional

No description available.

maxLength: 1000 bytes

rkey string record-key Required

A valid record key for AT Protocol repositories.

space string Required

The management space it was written in, as <space-type>/<space-id>.

maxLength: 512 bytes

spaces array of 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": "One us.off-the-clock.community.membership record.",
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "counts": {
      "description": "Its author is an effective admin, so it grants what it names.",
      "type": "boolean"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "note": {
      "maxLength": 1000,
      "type": "string"
    },
    "rkey": {
      "format": "record-key",
      "type": "string"
    },
    "space": {
      "description": "The management space it was written in, as <space-type>/<space-id>.",
      "maxLength": 512,
      "type": "string"
    },
    "spaces": {
      "items": {
        "description": "<space-type>/<space-id>: a pair's content space",
        "maxLength": 512,
        "type": "string"
      },
      "type": "array"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "space",
    "author",
    "rkey",
    "spaces",
    "indexedAt",
    "counts"
  ],
  "type": "object"
}

label object

A label that counts.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

cts string datetime Required

An RFC 3339 formatted timestamp.

record string at-uri Required

The label record, in the management space.

src string did Required

A decentralized identifier (DID).

target string Required

The record URI, blob CID or DID labelled.

val string Required

No description available.

View raw schema

{
  "description": "A label that counts.",
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "cts": {
      "format": "datetime",
      "type": "string"
    },
    "record": {
      "description": "The label record, in the management space.",
      "format": "at-uri",
      "type": "string"
    },
    "src": {
      "format": "did",
      "type": "string"
    },
    "target": {
      "description": "The record URI, blob CID or DID labelled.",
      "type": "string"
    },
    "val": {
      "type": "string"
    }
  },
  "required": [
    "record",
    "src",
    "val",
    "target",
    "cts"
  ],
  "type": "object"
}

member object

A DID some membership record names, with every record behind it.

Properties

admin boolean Required

No description available.

adminOf array of stringtid Required

The TIDs of the pairs the DID administers.

did string did Required

A decentralized identifier (DID).

grants array of ref#grant Required

No description available.

handle string handle Optional

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

invited boolean Optional

A counting grant names the DID but it has not joined yet (D60).

joinedAt string datetime Optional

When the DID joined: its acceptance's createdAt.

member boolean Required

No description available.

spaces array of string Required

Effective spaces; for an invited DID, what its grants will give it.

View raw schema

{
  "description": "A DID some membership record names, with every record behind it.",
  "properties": {
    "admin": {
      "type": "boolean"
    },
    "adminOf": {
      "description": "The TIDs of the pairs the DID administers.",
      "items": {
        "format": "tid",
        "type": "string"
      },
      "type": "array"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "grants": {
      "items": {
        "ref": "#grant",
        "type": "ref"
      },
      "type": "array"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    },
    "invited": {
      "description": "A counting grant names the DID but it has not joined yet (D60).",
      "type": "boolean"
    },
    "joinedAt": {
      "description": "When the DID joined: its acceptance's createdAt.",
      "format": "datetime",
      "type": "string"
    },
    "member": {
      "type": "boolean"
    },
    "spaces": {
      "description": "Effective spaces; for an invited DID, what its grants will give it.",
      "items": {
        "description": "<space-type>/<space-id>: a pair's content space",
        "maxLength": 512,
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "did",
    "member",
    "admin",
    "adminOf",
    "spaces",
    "grants"
  ],
  "type": "object"
}

pair object

A registered pair (D33, D34): its space record, its team and both halves.

Properties

admins array of stringdid Required

The pair's own team: the members of team grants (D35).

content ref #space Required

No description available.

default boolean Required

No description available.

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.

management ref #space Required

No description available.

tid string tid Required

A timestamp-based identifier (TID).

View raw schema

{
  "description": "A registered pair (D33, D34): its space record, its team and both halves.",
  "properties": {
    "admins": {
      "description": "The pair's own team: the members of team grants (D35).",
      "items": {
        "format": "did",
        "type": "string"
      },
      "type": "array"
    },
    "content": {
      "ref": "#space",
      "type": "ref"
    },
    "default": {
      "type": "boolean"
    },
    "defaultFeed": {
      "format": "record-key",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "management": {
      "ref": "#space",
      "type": "ref"
    },
    "tid": {
      "format": "tid",
      "type": "string"
    }
  },
  "required": [
    "tid",
    "displayName",
    "defaultFeed",
    "default",
    "admins",
    "management",
    "content"
  ],
  "type": "object"
}

record object

Any indexed record, hidden or not.

Properties

author string did Required

A decentralized identifier (DID).

authorMember boolean Required

The author may still use the record's space; if not, the record is hidden.

cid string cid Required

A content identifier (CID) referencing immutable data.

collection string nsid Required

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

handle string handle Optional

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

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refus.off-the-clock.admin.defs#label Required

No description available.

rkey string record-key Required

A valid record key for AT Protocol repositories.

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 indexed record, hidden or not.",
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "authorMember": {
      "description": "The author may still use the record's space; if not, the record is hidden.",
      "type": "boolean"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "collection": {
      "format": "nsid",
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "us.off-the-clock.admin.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "rkey": {
      "format": "record-key",
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "value": {
      "type": "unknown"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "collection",
    "rkey",
    "value",
    "indexedAt",
    "authorMember",
    "labels"
  ],
  "type": "object"
}

space object

A space the community names (D34), and how the AppView follows it.

Properties

blobs integer Required

No description available.

caughtUp boolean Required

No description available.

credential unknown Optional

The AppView's credential state in the space.

followed boolean Required

No description available.

key string Optional

The pair's TID, for a pair's half.

maxLength: 512 bytes

records integer Required

No description available.

space string Required

<space-type>/<space-id>

maxLength: 512 bytes

uri string uri Required

A valid URI.

View raw schema

{
  "description": "A space the community names (D34), and how the AppView follows it.",
  "properties": {
    "blobs": {
      "type": "integer"
    },
    "caughtUp": {
      "type": "boolean"
    },
    "credential": {
      "description": "The AppView's credential state in the space.",
      "type": "unknown"
    },
    "followed": {
      "type": "boolean"
    },
    "key": {
      "description": "The pair's TID, for a pair's half.",
      "maxLength": 512,
      "type": "string"
    },
    "records": {
      "type": "integer"
    },
    "space": {
      "description": "<space-type>/<space-id>",
      "maxLength": 512,
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "space",
    "uri",
    "followed",
    "caughtUp",
    "records",
    "blobs"
  ],
  "type": "object"
}