# social.colibri.beta.label

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.label)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.label/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.label/examples)

## Definitions

### `social.colibri.beta.label`

**Type**: `record`

A label applied to a record in the same space. Permissioned content cannot be taken down by anyone but its author, so moderation of content is advisory: a reader honours the labels published by the labelers its community names.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `neg` | `boolean` | No | Whether this record retracts an earlier label of the same value. |
| `val` | `string` | Yes | The label value. `hidden` is enforced: the AppView withholds a hidden record instead of serving it. `spoiler` and `embeds-suppressed` are display hints the AppView passes through for the client to honour. |
| `scope` | `array` | No | URIs within the subject record the label narrows to, for values that can apply to part of a record. Absent means the whole record. |
| `reason` | `string` | No | Human-readable reason. |
| `subject` | `ref` → `#subject` | Yes | The record this label applies to. |
| `createdAt` | `string` (datetime) | Yes | When the label was applied. |

### `social.colibri.beta.label#subject`

**Type**: `object`

The labelled record, addressed within the space the label lives in.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | DID of the repo holding the labelled record. |
| `rkey` | `string` (record-key) | Yes | The labelled record's key. |
| `collection` | `string` (nsid) | Yes | The labelled record's collection. |

## Raw Schema

```json
{
  "id": "social.colibri.beta.label",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject",
          "val",
          "createdAt"
        ],
        "properties": {
          "neg": {
            "type": "boolean",
            "default": false,
            "description": "Whether this record retracts an earlier label of the same value."
          },
          "val": {
            "type": "string",
            "maxLength": 128,
            "description": "The label value. `hidden` is enforced: the AppView withholds a hidden record instead of serving it. `spoiler` and `embeds-suppressed` are display hints the AppView passes through for the client to honour.",
            "knownValues": [
              "hidden",
              "spoiler",
              "embeds-suppressed"
            ]
          },
          "scope": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "description": "URIs within the subject record the label narrows to, for values that can apply to part of a record. Absent means the whole record."
          },
          "reason": {
            "type": "string",
            "maxLength": 512,
            "description": "Human-readable reason."
          },
          "subject": {
            "ref": "#subject",
            "type": "ref",
            "description": "The record this label applies to."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the label was applied."
          }
        }
      },
      "description": "A label applied to a record in the same space. Permissioned content cannot be taken down by anyone but its author, so moderation of content is advisory: a reader honours the labels published by the labelers its community names."
    },
    "subject": {
      "type": "object",
      "required": [
        "did",
        "collection",
        "rkey"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "DID of the repo holding the labelled record."
        },
        "rkey": {
          "type": "string",
          "format": "record-key",
          "description": "The labelled record's key."
        },
        "collection": {
          "type": "string",
          "format": "nsid",
          "description": "The labelled record's collection."
        }
      },
      "description": "The labelled record, addressed within the space the label lives in."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```