wiki.lichen.listNotes
Schema Diff
+13 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 2 non-breaking changes.
Non-Breaking Changes (2)
- AddedVertex AddedVertex { vertex_id: "wiki.lichen.listNotes#noteView.status" }
- AddedEdge AddedEdge { src: "wiki.lichen.listNotes#noteView", tgt: "wiki.lichen.listNotes#noteView.status", kind: "prop", name: Some("status") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "wiki.lichen.listNotes#noteView.status" }
Additional Notes
- Non-breaking: AddedEdge { src: "wiki.lichen.listNotes#noteView", tgt: "wiki.lichen.listNotes#noteView.status", kind: "prop", name: Some("status") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
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
+
"includeDeleted": {
39
+
"default": false,
40
+
"description": "Also list deleted notes, each marked by its status.",
41
+
"type": "boolean"
42
+
},
38
43
"limit": {
39
44
"default": 50,
40
45
"maximum": 100,
41
46
"minimum": 1,
42
47
"type": "integer"
43
48
},
44
49
"wiki": {
45
50
"description": "AT-URI of the wiki record.",
46
51
"format": "at-uri",
47
52
"type": "string"
48
53
}
49
54
},
50
55
"required": [
51
56
"wiki"
52
57
],
53
58
"type": "params"
54
59
},
55
60
"type": "query"
56
61
},
57
62
"noteView": {
58
63
"properties": {
59
64
"latestRevisionUri": {
60
65
"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.",
61
66
"format": "at-uri",
62
67
"type": "string"
63
68
},
64
69
"slug": {
65
70
"type": "string"
66
71
},
72
+
"status": {
73
+
"description": "Present on a deleted note, which is listed only with includeDeleted.",
74
+
"knownValues": [
75
+
"live",
76
+
"deleted"
77
+
],
78
+
"type": "string"
79
+
},
67
80
"title": {
68
81
"type": "string"
69
82
},
70
83
"updatedAt": {
71
84
"description": "The head revision's own timestamp, so appviews holding the same history agree. An unusable stamp falls back to our ingest time.",
72
85
"format": "datetime",
73
86
"type": "string"
74
87
},
75
88
"uri": {
76
89
"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.",
77
90
"format": "at-uri",
78
91
"type": "string"
79
92
}
80
93
},
81
94
"required": [
82
95
"uri",
83
96
"slug",
84
97
"title",
85
98
"latestRevisionUri",
86
99
"updatedAt"
87
100
],
88
101
"type": "object"
89
102
}
90
103
},
91
104
"id": "wiki.lichen.listNotes",
92
105
"lexicon": 1
93
106
}