Lexicon Garden

pub.chive.collection.getMarginAnnotations

Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · query
Kindquery
Authoritycollection.chive.pub
Indexed

Showing version bafyreiehulxtvdege2tmd47bqnztr54smhr7b2da5qbcsfx7ywdcnlgsua. Show the latest

Compare Edit in builder → Fork →
cid bafyreiehulxtvdege2tmd47bqnztr54smhr7b2da5qbcsfx7ywdcnlgsua

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "annotationView": {
      "properties": {
        "authorDid": {
          "description": "DID of the annotation author",
          "type": "string"
        },
        "body": {
          "description": "Annotation body text",
          "type": "string"
        },
        "bodyFormat": {
          "description": "Body MIME type",
          "type": "string"
        },
        "color": {
          "description": "Highlight color",
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "motivation": {
          "description": "W3C annotation motivation",
          "type": "string"
        },
        "pageTitle": {
          "description": "Page title at annotation time",
          "type": "string"
        },
        "recordType": {
          "description": "Record type: annotation or highlight",
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "uri": {
          "description": "AT-URI of the annotation record",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "authorDid",
        "recordType",
        "createdAt"
      ],
      "type": "object"
    },
    "main": {
      "description": "Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "annotations": {
              "items": {
                "ref": "#annotationView",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "type": "string"
            },
            "hasMore": {
              "type": "boolean"
            },
            "total": {
              "type": "integer"
            }
          },
          "required": [
            "annotations"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor",
            "type": "string"
          },
          "eprintUri": {
            "description": "AT-URI of the eprint to get annotations for",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "Maximum results to return",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "eprintUri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "pub.chive.collection.getMarginAnnotations",
  "lexicon": 1,
  "revision": 1
}