# us.off-the-clock.admin.defs

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.defs/examples)

## Definitions

### `us.off-the-clock.admin.defs#blob`

**Type**: `object`

A blob records in the space reference.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `did` | `string` (did) | Yes |  |
| `labels` | `array` | Yes |  |
| `mime` | `string` | No |  |
| `records` | `integer` | Yes |  |

### `us.off-the-clock.admin.defs#collectionCount`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `collection` | `string` (nsid) | Yes |  |
| `count` | `integer` | Yes |  |

### `us.off-the-clock.admin.defs#feed`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `configuration` | `unknown` | Yes |  |
| `default` | `boolean` | Yes | The feed the pair's space record names. |
| `displayName` | `string` | Yes |  |
| `rkey` | `string` (record-key) | Yes |  |
| `sort` | `string` | Yes |  |
| `text` | `string` | Yes |  |

### `us.off-the-clock.admin.defs#grant`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `counts` | `boolean` | Yes | Its author is an effective admin, so it grants what it names. |
| `indexedAt` | `string` (datetime) | Yes |  |
| `note` | `string` | No |  |
| `rkey` | `string` (record-key) | Yes |  |
| `space` | `string` | Yes | The management space it was written in, as <space-type>/<space-id>. |
| `spaces` | `array` | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |

### `us.off-the-clock.admin.defs#label`

**Type**: `object`

A label that counts.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | No |  |
| `cts` | `string` (datetime) | Yes |  |
| `record` | `string` (at-uri) | Yes | The label record, in the management space. |
| `src` | `string` (did) | Yes |  |
| `target` | `string` | Yes | The record URI, blob CID or DID labelled. |
| `val` | `string` | Yes |  |

### `us.off-the-clock.admin.defs#member`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `admin` | `boolean` | Yes |  |
| `adminOf` | `array` | Yes | The TIDs of the pairs the DID administers. |
| `did` | `string` (did) | Yes |  |
| `grants` | `array` | Yes |  |
| `handle` | `string` (handle) | No |  |
| `invited` | `boolean` | No | A counting grant names the DID but it has not joined yet (D60). |
| `joinedAt` | `string` (datetime) | No | When the DID joined: its acceptance's createdAt. |
| `member` | `boolean` | Yes |  |
| `spaces` | `array` | Yes | Effective spaces; for an invited DID, what its grants will give it. |

### `us.off-the-clock.admin.defs#pair`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `admins` | `array` | Yes | The pair's own team: the members of team grants (D35). |
| `content` | `ref` → `#space` | Yes |  |
| `default` | `boolean` | Yes |  |
| `defaultFeed` | `string` (record-key) | Yes |  |
| `description` | `string` | No |  |
| `displayName` | `string` | Yes |  |
| `management` | `ref` → `#space` | Yes |  |
| `tid` | `string` (tid) | Yes |  |

### `us.off-the-clock.admin.defs#record`

**Type**: `object`

Any indexed record, hidden or not.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `authorMember` | `boolean` | Yes | The author may still use the record's space; if not, the record is hidden. |
| `cid` | `string` (cid) | Yes |  |
| `collection` | `string` (nsid) | Yes |  |
| `handle` | `string` (handle) | No |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `labels` | `array` | Yes |  |
| `rkey` | `string` (record-key) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `unknown` | Yes |  |

### `us.off-the-clock.admin.defs#space`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `blobs` | `integer` | Yes |  |
| `caughtUp` | `boolean` | Yes |  |
| `credential` | `unknown` | No | The AppView's credential state in the space. |
| `followed` | `boolean` | Yes |  |
| `key` | `string` | No | The pair's TID, for a pair's half. |
| `records` | `integer` | Yes |  |
| `space` | `string` | Yes | <space-type>/<space-id> |
| `uri` | `string` (uri) | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "blob": {
      "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": {
      "properties": {
        "collection": {
          "format": "nsid",
          "type": "string"
        },
        "count": {
          "type": "integer"
        }
      },
      "required": [
        "collection",
        "count"
      ],
      "type": "object"
    },
    "feed": {
      "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": {
      "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": {
      "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": {
      "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": {
      "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": {
      "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": {
      "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"
    }
  },
  "id": "us.off-the-clock.admin.defs",
  "lexicon": 1
}
```