full diff

pub.chive.collection.getMarginAnnotations

From
bafyreiehulxtvdege2tmd47bqnztr54smhr7b2da5qbcsfx7ywdcnlgsua indexed 2026-06-18 13:14 UTC View this version
To
bafyreiehulxtvdege2tmd47bqnztr54smhr7b2da5qbcsfx7ywdcnlgsua indexed 2026-06-18 13:14 UTC View this version

Compatibility

backward compatible No changes detected.

Changes

11{
22 "$type": "com.atproto.lexicon.schema",
33 "defs": {
44 "annotationView": {
55 "properties": {
66 "authorDid": {
77 "description": "DID of the annotation author",
88 "type": "string"
99 },
1010 "body": {
1111 "description": "Annotation body text",
1212 "type": "string"
1313 },
1414 "bodyFormat": {
1515 "description": "Body MIME type",
1616 "type": "string"
1717 },
1818 "color": {
1919 "description": "Highlight color",
2020 "type": "string"
2121 },
2222 "createdAt": {
2323 "format": "datetime",
2424 "type": "string"
2525 },
2626 "motivation": {
2727 "description": "W3C annotation motivation",
2828 "type": "string"
2929 },
3030 "pageTitle": {
3131 "description": "Page title at annotation time",
3232 "type": "string"
3333 },
3434 "recordType": {
3535 "description": "Record type: annotation or highlight",
3636 "type": "string"
3737 },
3838 "tags": {
3939 "items": {
4040 "type": "string"
4141 },
4242 "type": "array"
4343 },
4444 "uri": {
4545 "description": "AT-URI of the annotation record",
4646 "type": "string"
4747 }
4848 },
4949 "required": [
5050 "uri",
5151 "authorDid",
5252 "recordType",
5353 "createdAt"
5454 ],
5555 "type": "object"
5656 },
5757 "main": {
5858 "description": "Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint",
5959 "output": {
6060 "encoding": "application/json",
6161 "schema": {
6262 "properties": {
6363 "annotations": {
6464 "items": {
6565 "ref": "#annotationView",
6666 "type": "ref"
6767 },
6868 "type": "array"
6969 },
7070 "cursor": {
7171 "type": "string"
7272 },
7373 "hasMore": {
7474 "type": "boolean"
7575 },
7676 "total": {
7777 "type": "integer"
7878 }
7979 },
8080 "required": [
8181 "annotations"
8282 ],
8383 "type": "object"
8484 }
8585 },
8686 "parameters": {
8787 "properties": {
8888 "cursor": {
8989 "description": "Pagination cursor",
9090 "type": "string"
9191 },
9292 "eprintUri": {
9393 "description": "AT-URI of the eprint to get annotations for",
9494 "type": "string"
9595 },
9696 "limit": {
9797 "default": 50,
9898 "description": "Maximum results to return",
9999 "maximum": 100,
100100 "minimum": 1,
101101 "type": "integer"
102102 }
103103 },
104104 "required": [
105105 "eprintUri"
106106 ],
107107 "type": "params"
108108 },
109109 "type": "query"
110110 }
111111 },
112112 "id": "pub.chive.collection.getMarginAnnotations",
113113 "lexicon": 1,
114114 "revision": 1
115115}