# tools.umbrae.labelerReasons

> A private labeler's report reasons, so a client can render its report form.

- Kind: record
- Record key: literal:self
- Authority: umbrae.tools
- Lexicon: 1
- Published by [lexicons.umbrae.tools](https://lexicon.garden/identity/did:plc:656sqbhftme2qbyjtcc2q6jk), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.labelerReasons)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.labelerReasons/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.labelerReasons/analytics)

## Record (`tools.umbrae.labelerReasons`)

Type: record · key literal:self

### Properties

- `createdAt` (string · datetime, required)
- `groups` (array): Optional headings to show reasons under. Clients that ignore them show a flat list.
  - Constraints: maxLength: 100
  - `items` (ref)
    - Reference: `#group`
- `reasons` (array, required)
  - Constraints: maxLength: 500
  - `items` (ref)
    - Reference: `#reason`

## #group (`tools.umbrae.labelerReasons#group`)

Type: object

### Properties

- `id` (string, required)
  - Constraints: minLength: 1, maxLength: 128
- `locales` (array, required)
  - `items` (ref)
    - Reference: `#reasonStrings`

## #reason (`tools.umbrae.labelerReasons#reason`)

Type: object

### Properties

- `group` (string): The id of a group in groups to show this reason under.
  - Constraints: minLength: 1, maxLength: 128
- `locales` (array, required)
  - `items` (ref)
    - Reference: `#reasonStrings`
- `type` (ref, required): The reason code a report carries.
  - Reference: `com.atproto.moderation.defs#reasonType`

## #reasonStrings (`tools.umbrae.labelerReasons#reasonStrings`)

Type: object

### Properties

- `description` (string, required)
  - Constraints: maxLength: 100000, maxGraphemes: 10000
- `lang` (string · language, required)
- `title` (string, required)
  - Constraints: maxLength: 640, maxGraphemes: 64

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "group": {
      "properties": {
        "id": {
          "maxLength": 128,
          "minLength": 1,
          "type": "string"
        },
        "locales": {
          "items": {
            "ref": "#reasonStrings",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "id",
        "locales"
      ],
      "type": "object"
    },
    "main": {
      "description": "A private labeler's report reasons, so a client can render its report form.",
      "key": "literal:self",
      "record": {
        "properties": {
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "groups": {
            "description": "Optional headings to show reasons under. Clients that ignore them show a flat list.",
            "items": {
              "ref": "#group",
              "type": "ref"
            },
            "maxLength": 100,
            "type": "array"
          },
          "reasons": {
            "items": {
              "ref": "#reason",
              "type": "ref"
            },
            "maxLength": 500,
            "type": "array"
          }
        },
        "required": [
          "reasons",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "reason": {
      "properties": {
        "group": {
          "description": "The id of a group in groups to show this reason under.",
          "maxLength": 128,
          "minLength": 1,
          "type": "string"
        },
        "locales": {
          "items": {
            "ref": "#reasonStrings",
            "type": "ref"
          },
          "type": "array"
        },
        "type": {
          "description": "The reason code a report carries.",
          "ref": "com.atproto.moderation.defs#reasonType",
          "type": "ref"
        }
      },
      "required": [
        "type",
        "locales"
      ],
      "type": "object"
    },
    "reasonStrings": {
      "properties": {
        "description": {
          "maxGraphemes": 10000,
          "maxLength": 100000,
          "type": "string"
        },
        "lang": {
          "format": "language",
          "type": "string"
        },
        "title": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        }
      },
      "required": [
        "lang",
        "title",
        "description"
      ],
      "type": "object"
    }
  },
  "id": "tools.umbrae.labelerReasons",
  "lexicon": 1
}
```
