pub.chive.annotation.listForEprint

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "annotationView": {
      "description": "View of an annotation/comment",
      "properties": {
        "author": {
          "ref": "#authorRef",
          "type": "ref"
        },
        "body": {
          "description": "Rich text body items",
          "items": {
            "refs": [
              "pub.chive.richtext.defs#textItem",
              "pub.chive.richtext.defs#nodeRefItem",
              "pub.chive.richtext.defs#wikidataRefItem",
              "pub.chive.richtext.defs#fieldRefItem",
              "pub.chive.richtext.defs#facetRefItem",
              "pub.chive.richtext.defs#eprintRefItem",
              "pub.chive.richtext.defs#annotationRefItem",
              "pub.chive.richtext.defs#authorRefItem",
              "pub.chive.richtext.defs#mentionItem",
              "pub.chive.richtext.defs#linkItem",
              "pub.chive.richtext.defs#tagItem",
              "pub.chive.richtext.defs#latexItem",
              "pub.chive.richtext.defs#codeBlockItem",
              "pub.chive.richtext.defs#headingItem",
              "pub.chive.richtext.defs#listItem",
              "pub.chive.richtext.defs#blockquoteItem"
            ],
            "type": "union"
          },
          "maxLength": 500,
          "type": "array"
        },
        "bodyPlainText": {
          "description": "Plain text body for search/preview",
          "type": "string"
        },
        "cid": {
          "description": "Content identifier",
          "type": "string"
        },
        "content": {
          "description": "Plain text content of the annotation",
          "type": "string"
        },
        "createdAt": {
          "description": "When the annotation was created",
          "format": "datetime",
          "type": "string"
        },
        "deleted": {
          "default": false,
          "description": "Whether this annotation has been deleted (tombstone for thread preservation)",
          "type": "boolean"
        },
        "eprintUri": {
          "description": "AT-URI of the annotated eprint",
          "format": "at-uri",
          "type": "string"
        },
        "indexedAt": {
          "description": "When the annotation was indexed",
          "format": "datetime",
          "type": "string"
        },
        "motivation": {
          "description": "W3C Web Annotation motivation",
          "knownValues": [
            "commenting",
            "highlighting",
            "questioning",
            "replying",
            "assessing",
            "bookmarking",
            "classifying",
            "describing",
            "editing",
            "moderating",
            "tagging"
          ],
          "type": "string"
        },
        "parentAnnotationUri": {
          "description": "Parent annotation URI for threaded replies",
          "format": "at-uri",
          "type": "string"
        },
        "replyCount": {
          "description": "Number of direct replies",
          "minimum": 0,
          "type": "integer"
        },
        "target": {
          "description": "Target text span for the annotation",
          "ref": "#textSpanTarget",
          "type": "ref"
        },
        "uri": {
          "description": "Annotation AT-URI",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid",
        "author",
        "eprintUri",
        "content",
        "motivation",
        "target",
        "replyCount",
        "createdAt",
        "indexedAt"
      ],
      "type": "object"
    },
    "authorLink": {
      "description": "Link to an ATProto author",
      "properties": {
        "did": {
          "description": "Author's DID",
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "description": "Author's display name",
          "type": "string"
        },
        "handle": {
          "description": "Author's handle",
          "format": "handle",
          "type": "string"
        },
        "orcid": {
          "description": "Author's ORCID (if available)",
          "type": "string"
        },
        "type": {
          "const": "author",
          "type": "string"
        }
      },
      "required": [
        "type",
        "did",
        "displayName"
      ],
      "type": "object"
    },
    "authorRef": {
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "handle": {
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    },
    "boundingRect": {
      "description": "Bounding rectangle coordinates for highlight positioning. All values stored as strings to preserve floating-point precision since ATProto only supports integer type.",
      "properties": {
        "height": {
          "description": "Page height reference (as string to preserve float precision)",
          "type": "string"
        },
        "pageNumber": {
          "description": "1-indexed page number for the bounding rectangle",
          "minimum": 1,
          "type": "integer"
        },
        "width": {
          "description": "Page width reference (as string to preserve float precision)",
          "type": "string"
        },
        "x1": {
          "description": "Left edge coordinate (as string to preserve float precision)",
          "type": "string"
        },
        "x2": {
          "description": "Right edge coordinate (as string to preserve float precision)",
          "type": "string"
        },
        "y1": {
          "description": "Top edge coordinate (as string to preserve float precision)",
          "type": "string"
        },
        "y2": {
          "description": "Bottom edge coordinate (as string to preserve float precision)",
          "type": "string"
        }
      },
      "required": [
        "x1",
        "y1",
        "x2",
        "y2",
        "width",
        "height",
        "pageNumber"
      ],
      "type": "object"
    },
    "entityLinkView": {
      "description": "View of an entity link annotation",
      "properties": {
        "cid": {
          "description": "Content identifier",
          "type": "string"
        },
        "confidence": {
          "description": "Confidence score (0-1000, scaled from 0.0-1.0)",
          "maximum": 1000,
          "minimum": 0,
          "type": "integer"
        },
        "createdAt": {
          "description": "When the entity link was created",
          "format": "datetime",
          "type": "string"
        },
        "creator": {
          "description": "Creator of the entity link",
          "ref": "#authorRef",
          "type": "ref"
        },
        "eprintUri": {
          "description": "AT-URI of the eprint containing the linked text",
          "format": "at-uri",
          "type": "string"
        },
        "indexedAt": {
          "description": "When the entity link was indexed",
          "format": "datetime",
          "type": "string"
        },
        "linkedEntity": {
          "description": "The linked entity",
          "refs": [
            "#graphNodeLink",
            "#externalIdLink",
            "#authorLink",
            "#eprintLink"
          ],
          "type": "union"
        },
        "target": {
          "description": "Target text span linked to the entity",
          "ref": "#textSpanTarget",
          "type": "ref"
        },
        "uri": {
          "description": "Entity link AT-URI",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid",
        "creator",
        "eprintUri",
        "target",
        "linkedEntity",
        "createdAt",
        "indexedAt"
      ],
      "type": "object"
    },
    "eprintLink": {
      "description": "Link to another eprint/preprint",
      "properties": {
        "doi": {
          "description": "DOI if available",
          "type": "string"
        },
        "title": {
          "description": "Eprint title",
          "type": "string"
        },
        "type": {
          "const": "eprint",
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the eprint",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "type",
        "uri",
        "title"
      ],
      "type": "object"
    },
    "externalIdLink": {
      "description": "Link to an external identifier (Wikidata, ROR, ORCID, etc.)",
      "properties": {
        "identifier": {
          "description": "Identifier value (e.g., Q42 for Wikidata)",
          "type": "string"
        },
        "label": {
          "description": "Display label for the entity",
          "type": "string"
        },
        "system": {
          "description": "External identifier system",
          "knownValues": [
            "wikidata",
            "ror",
            "orcid",
            "isni",
            "viaf",
            "lcsh",
            "fast",
            "credit",
            "spdx",
            "fundref",
            "mesh",
            "aat",
            "gnd",
            "anzsrc",
            "arxiv",
            "doi",
            "pmid",
            "pmcid"
          ],
          "type": "string"
        },
        "type": {
          "const": "externalId",
          "type": "string"
        },
        "uri": {
          "description": "Full URI for the external entity",
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "type",
        "system",
        "identifier",
        "label"
      ],
      "type": "object"
    },
    "graphNodeLink": {
      "description": "Link to a knowledge graph node",
      "properties": {
        "id": {
          "description": "Node UUID identifier",
          "type": "string"
        },
        "kind": {
          "description": "Node kind: 'type' for classifications, 'object' for instances",
          "knownValues": [
            "type",
            "object"
          ],
          "type": "string"
        },
        "label": {
          "description": "Display label for the node",
          "type": "string"
        },
        "slug": {
          "description": "Human-readable slug (e.g., 'computer-science')",
          "type": "string"
        },
        "subkind": {
          "description": "Subkind slug (e.g., 'field', 'facet', 'institution', 'contribution-type')",
          "type": "string"
        },
        "subkindUri": {
          "description": "AT-URI of the subkind type node",
          "format": "at-uri",
          "type": "string"
        },
        "type": {
          "const": "graphNode",
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the graph node",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "type",
        "uri",
        "label",
        "kind"
      ],
      "type": "object"
    },
    "linkedEntityRef": {
      "description": "Union wrapper for linked entity references",
      "properties": {
        "entity": {
          "refs": [
            "#graphNodeLink",
            "#externalIdLink",
            "#authorLink",
            "#eprintLink"
          ],
          "type": "union"
        }
      },
      "type": "object"
    },
    "main": {
      "description": "List annotations for a specific eprint with optional filtering",
      "errors": [],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "annotations": {
              "description": "List of annotations for the eprint",
              "items": {
                "ref": "#annotationView",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "description": "Cursor for next page",
              "type": "string"
            },
            "entityLinks": {
              "description": "Included when includeEntityLinks=true",
              "items": {
                "ref": "#entityLinkView",
                "type": "ref"
              },
              "type": "array"
            },
            "hasMore": {
              "description": "Whether more results are available",
              "type": "boolean"
            },
            "total": {
              "description": "Total number of annotations for this eprint",
              "type": "integer"
            }
          },
          "required": [
            "annotations",
            "hasMore"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor for next page",
            "type": "string"
          },
          "eprintUri": {
            "description": "AT-URI of the eprint",
            "format": "at-uri",
            "type": "string"
          },
          "includeEntityLinks": {
            "default": false,
            "description": "Include entity link annotations in response",
            "type": "boolean"
          },
          "limit": {
            "default": 50,
            "description": "Maximum number of results to return",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "motivation": {
            "description": "Filter by annotation motivation",
            "knownValues": [
              "commenting",
              "questioning",
              "highlighting",
              "replying"
            ],
            "type": "string"
          },
          "pageNumber": {
            "description": "Filter to specific page number",
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "eprintUri"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "textPositionSelector": {
      "description": "W3C Text Position Selector with optional page info",
      "properties": {
        "boundingRect": {
          "description": "Bounding rectangle for visual positioning",
          "ref": "#boundingRect",
          "type": "ref"
        },
        "end": {
          "minimum": 0,
          "type": "integer"
        },
        "pageNumber": {
          "description": "0-indexed page number in PDF",
          "minimum": 0,
          "type": "integer"
        },
        "start": {
          "minimum": 0,
          "type": "integer"
        },
        "type": {
          "const": "TextPositionSelector",
          "type": "string"
        }
      },
      "required": [
        "type",
        "start",
        "end"
      ],
      "type": "object"
    },
    "textQuoteSelector": {
      "description": "W3C Text Quote Selector",
      "properties": {
        "exact": {
          "maxLength": 1000,
          "type": "string"
        },
        "prefix": {
          "maxLength": 100,
          "type": "string"
        },
        "suffix": {
          "maxLength": 100,
          "type": "string"
        },
        "type": {
          "const": "TextQuoteSelector",
          "type": "string"
        }
      },
      "required": [
        "type",
        "exact"
      ],
      "type": "object"
    },
    "textSpanTarget": {
      "description": "Target text span for inline annotations (W3C Web Annotation compatible)",
      "properties": {
        "page": {
          "description": "0-indexed page number",
          "minimum": 0,
          "type": "integer"
        },
        "refinedBy": {
          "description": "Position refinement with page info",
          "ref": "#textPositionSelector",
          "type": "ref"
        },
        "selector": {
          "description": "Text quote selector",
          "ref": "#textQuoteSelector",
          "type": "ref"
        },
        "source": {
          "description": "Eprint AT-URI",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "source"
      ],
      "type": "object"
    }
  },
  "id": "pub.chive.annotation.listForEprint",
  "lexicon": 1,
  "revision": 1
}