at.margin.highlight

margin.at

Documentation

A highlight on a web page (motivation: highlighting)

main record

A highlight on a web page (motivation: highlighting)

Record Key tid Timestamp-based ID

Properties

color string Optional

Highlight color (hex or named)

maxLength: 20 bytes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

generator object Optional

The client/agent that created this record

rights string uri Optional

License URI (e.g., https://creativecommons.org/licenses/by/4.0/)

tags array of string Optional

Tags for categorization

maxLength: 10 items
View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "target",
      "createdAt"
    ],
    "properties": {
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 64,
          "maxGraphemes": 32
        },
        "maxLength": 10,
        "description": "Tags for categorization"
      },
      "color": {
        "type": "string",
        "maxLength": 20,
        "description": "Highlight color (hex or named)"
      },
      "labels": {
        "ref": "com.atproto.label.defs#selfLabels",
        "type": "ref",
        "description": "Self-applied content labels for this highlight"
      },
      "rights": {
        "type": "string",
        "format": "uri",
        "description": "License URI (e.g., https://creativecommons.org/licenses/by/4.0/)"
      },
      "target": {
        "ref": "at.margin.annotation#target",
        "type": "ref",
        "description": "The resource and segment being highlighted"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "generator": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uri"
          },
          "name": {
            "type": "string"
          },
          "homepage": {
            "type": "string",
            "format": "uri"
          }
        },
        "description": "The client/agent that created this record"
      }
    }
  },
  "description": "A highlight on a web page (motivation: highlighting)"
}

Lexicon Garden

@