social.colibri.beta.label

colibri.social

Documentation

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.

main 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.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When the label was applied.

neg boolean Optional

Whether this record retracts an earlier label of the same value.

Default: false
reason string Optional

Human-readable reason.

maxLength: 512 bytes
scope array of string uri Optional

URIs within the subject record the label narrows to, for values that can apply to part of a record. Absent means the whole record.

subject ref #subject Required

The record this label applies to.

val string Required

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.

maxLength: 128 bytes
Known values: hidden, spoiler, embeds-suppressed
View raw schema 
{
  "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 object

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

Properties

collection string nsid Required

The labelled record's collection.

did string did Required

DID of the repo holding the labelled record.

rkey string record-key Required

The labelled record's key.

View raw schema 
{
  "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."
}

Lexicon Garden

@