wiki.lichen.listNotes
Schema Diff
+4 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "List a public wiki's notes with the head revision of each. Carries no content by design: compare latestRevisionUri against what you hold and call wiki.lichen.getNote only for the notes that moved.",
5
+
"description": "List a public wiki's notes, each with its head revision. Compare latestRevisionUri with what you hold, then call getNote for the notes that changed.",
6
6
"errors": [
7
7
{
8
8
"name": "NotFound"
9
9
}
10
10
],
11
11
"output": {
12
12
"encoding": "application/json",
13
13
"schema": {
14
14
"properties": {
15
15
"cursor": {
16
16
"description": "Absent on the last page.",
17
17
"type": "string"
18
18
},
19
19
"notes": {
20
20
"items": {
21
21
"ref": "#noteView",
22
22
"type": "ref"
23
23
},
24
24
"type": "array"
25
25
}
26
26
},
27
27
"required": [
28
28
"notes"
29
29
],
30
30
"type": "object"
31
31
}
32
32
},
33
33
"parameters": {
34
34
"properties": {
35
35
"cursor": {
36
36
"type": "string"
37
37
},
38
38
"limit": {
39
39
"default": 50,
40
40
"maximum": 100,
41
41
"minimum": 1,
42
42
"type": "integer"
43
43
},
44
44
"wiki": {
45
45
"description": "AT-URI of the wiki record.",
46
46
"format": "at-uri",
47
47
"type": "string"
48
48
}
49
49
},
50
50
"required": [
51
51
"wiki"
52
52
],
53
53
"type": "params"
54
54
},
55
55
"type": "query"
56
56
},
57
57
"noteView": {
58
58
"properties": {
59
59
"latestRevisionUri": {
60
+
"description": "The head revision, the same value getNote returns. Compare it with what you hold to spot a change. Set it as parentRevision to write.",
60
61
"format": "at-uri",
61
62
"type": "string"
62
63
},
63
64
"slug": {
64
65
"type": "string"
65
66
},
66
67
"title": {
67
68
"type": "string"
68
69
},
69
70
"updatedAt": {
71
+
"description": "When the head last moved. The appview computes this.",
70
72
"format": "datetime",
71
73
"type": "string"
72
74
},
73
75
"uri": {
76
+
"description": "AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.",
74
77
"format": "at-uri",
75
78
"type": "string"
76
79
}
77
80
},
78
81
"required": [
79
82
"uri",
80
83
"slug",
81
84
"title",
82
85
"latestRevisionUri",
83
86
"updatedAt"
84
87
],
85
88
"type": "object"
86
89
}
87
90
},
88
91
"id": "wiki.lichen.listNotes",
89
92
"lexicon": 1
90
93
}