com.atproto.label.defs

atproto-lexicons.bsky.social

Documentation

label object

Metadata tag on an atproto resource (eg, repo or record).

Properties

cid string cid Optional

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

cts string datetime Required

Timestamp when this label was created.

exp string datetime Optional

Timestamp at which this label expires (no longer applies).

neg boolean Optional

If true, this is a negation label, overwriting a previous label.

sig bytes Optional

Signature of dag-cbor encoded label.

src string did Required

DID of the actor who created this label.

uri string uri Required

AT URI of the record, repository (account), or other resource that this label applies to.

val string Required

The short string name of the value or type of this label.

maxLength: 128 bytes

ver integer Optional

The AT Protocol version of the label object.

View raw schema

{
  "type": "object",
  "required": [
    "src",
    "uri",
    "val",
    "cts"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "Optionally, CID specifying the specific version of 'uri' resource this label applies to."
    },
    "cts": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp when this label was created."
    },
    "exp": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp at which this label expires (no longer applies)."
    },
    "neg": {
      "type": "boolean",
      "description": "If true, this is a negation label, overwriting a previous label."
    },
    "sig": {
      "type": "bytes",
      "description": "Signature of dag-cbor encoded label."
    },
    "src": {
      "type": "string",
      "format": "did",
      "description": "DID of the actor who created this label."
    },
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "AT URI of the record, repository (account), or other resource that this label applies to."
    },
    "val": {
      "type": "string",
      "maxLength": 128,
      "description": "The short string name of the value or type of this label."
    },
    "ver": {
      "type": "integer",
      "description": "The AT Protocol version of the label object."
    }
  },
  "description": "Metadata tag on an atproto resource (eg, repo or record)."
}

labelValue string

Known Values (other values may be valid)

!hide !no-promote !warn !no-unauthenticated dmca-violation doxxing porn sexual nudity nsfl gore

View raw schema

{
  "type": "string",
  "knownValues": [
    "!hide",
    "!no-promote",
    "!warn",
    "!no-unauthenticated",
    "dmca-violation",
    "doxxing",
    "porn",
    "sexual",
    "nudity",
    "nsfl",
    "gore"
  ]
}

labelValueDefinition object

Declares a label value and its expected interpretations and behaviors.

Properties

adultOnly boolean Optional

Does the user need to have adult content enabled in order to configure this label?

blurs string Required

What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.

Known values: content, media, none

defaultSetting string Optional

The default setting for this label.

Known values: ignore, warn, hide

identifier string Required

The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).

maxLength: 100 bytesmaxGraphemes: 100 graphemes

locales array of ref#labelValueDefinitionStrings Required

No description provided.

severity string Required

How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.

Known values: inform, alert, none

View raw schema

{
  "type": "object",
  "required": [
    "identifier",
    "severity",
    "blurs",
    "locales"
  ],
  "properties": {
    "blurs": {
      "type": "string",
      "description": "What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.",
      "knownValues": [
        "content",
        "media",
        "none"
      ]
    },
    "locales": {
      "type": "array",
      "items": {
        "ref": "#labelValueDefinitionStrings",
        "type": "ref"
      }
    },
    "severity": {
      "type": "string",
      "description": "How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.",
      "knownValues": [
        "inform",
        "alert",
        "none"
      ]
    },
    "adultOnly": {
      "type": "boolean",
      "description": "Does the user need to have adult content enabled in order to configure this label?"
    },
    "identifier": {
      "type": "string",
      "maxLength": 100,
      "description": "The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).",
      "maxGraphemes": 100
    },
    "defaultSetting": {
      "type": "string",
      "default": "warn",
      "description": "The default setting for this label.",
      "knownValues": [
        "ignore",
        "warn",
        "hide"
      ]
    }
  },
  "description": "Declares a label value and its expected interpretations and behaviors."
}

labelValueDefinitionStrings object

Strings which describe the label in the UI, localized into a specific language.

Properties

description string Required

A longer description of what the label means and why it might be applied.

maxLength: 100000 bytesmaxGraphemes: 10000 graphemes

lang string language Required

The code of the language these strings are written in.

name string Required

A short human-readable name for the label.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "lang",
    "name",
    "description"
  ],
  "properties": {
    "lang": {
      "type": "string",
      "format": "language",
      "description": "The code of the language these strings are written in."
    },
    "name": {
      "type": "string",
      "maxLength": 640,
      "description": "A short human-readable name for the label.",
      "maxGraphemes": 64
    },
    "description": {
      "type": "string",
      "maxLength": 100000,
      "description": "A longer description of what the label means and why it might be applied.",
      "maxGraphemes": 10000
    }
  },
  "description": "Strings which describe the label in the UI, localized into a specific language."
}

selfLabel object

Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.

Properties

val string Required

The short string name of the value or type of this label.

maxLength: 128 bytes

View raw schema

{
  "type": "object",
  "required": [
    "val"
  ],
  "properties": {
    "val": {
      "type": "string",
      "maxLength": 128,
      "description": "The short string name of the value or type of this label."
    }
  },
  "description": "Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel."
}

selfLabels object

Metadata tags on an atproto record, published by the author within the record.

Properties

values array of ref#selfLabel Required

No description provided.

maxLength: 10 bytes

View raw schema

{
  "type": "object",
  "required": [
    "values"
  ],
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "ref": "#selfLabel",
        "type": "ref"
      },
      "maxLength": 10
    }
  },
  "description": "Metadata tags on an atproto record, published by the author within the record."
}