wiki.lichen.getNote
Schema Diff
+8 -6
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "wiki.lichen.getNote:output", src: "wiki.lichen.getNote:output", tgt: "wiki.lichen.getNote:output.createdAt", kind: "prop", name: Some("createdAt") }
Migration Guidance
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "wiki.lichen.getNote:output", src: "wiki.lichen.getNote:output", tgt: "wiki.lichen.getNote:output.createdAt", kind: "prop", name: Some("createdAt") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Resolve a note and return its current content together with the head revision to write against. Public wikis only.",
5
+
"description": "Get a note's current content and the head revision to write against. Public wikis only.",
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
"content": {
16
-
"description": "The note's markdown exactly as its last revision left it. No frontmatter is added and no wikilinks are rewritten — writing this text back unchanged must produce an empty revision.",
16
+
"description": "The note's body as its last revision left it, byte for byte. Frontmatter and wikilinks stay exactly as the author wrote them. Writing this text back unchanged produces an empty revision.",
17
17
"type": "string"
18
18
},
19
19
"createdAt": {
20
-
"description": "Copied from the record. Absent when the record carried a stamp we cannot represent as a datetime.",
20
+
"description": "The note record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
21
21
"format": "datetime",
22
22
"type": "string"
23
23
},
24
24
"did": {
25
-
"description": "Who created the note record. Later revisions may be by anyone who may edit the wiki.",
25
+
"description": "The DID that created the note record. Later revisions can come from anyone allowed to edit the wiki.",
26
26
"format": "did",
27
27
"type": "string"
28
28
},
29
29
"latestRevisionUri": {
30
-
"description": "The head. Set it as parentRevision on a wiki.lichen.noteRevision to write against this content; a revision parented anywhere else does not move the note.",
30
+
"description": "The head revision. Set it as parentRevision on your noteRevision to write against this content. Only a revision parented here moves the note.",
31
31
"format": "at-uri",
32
32
"type": "string"
33
33
},
34
34
"slug": {
35
35
"type": "string"
36
36
},
37
37
"title": {
38
38
"type": "string"
39
39
},
40
40
"updatedAt": {
41
-
"description": "When the head last moved. Appview-derived, not a record field.",
41
+
"description": "The head revision's own timestamp, so appviews holding the same history agree. Same fallback as createdAt.",
42
42
"format": "datetime",
43
43
"type": "string"
44
44
},
45
45
"uri": {
46
+
"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.",
46
47
"format": "at-uri",
47
48
"type": "string"
48
49
},
49
50
"wiki": {
50
51
"format": "at-uri",
51
52
"type": "string"
52
53
}
53
54
},
54
55
"required": [
55
56
"uri",
56
57
"wiki",
57
58
"did",
58
59
"slug",
59
60
"title",
60
61
"content",
61
62
"latestRevisionUri",
63
+
"createdAt",
62
64
"updatedAt"
63
65
],
64
66
"type": "object"
65
67
}
66
68
},
67
69
"parameters": {
68
70
"properties": {
69
71
"slug": {
70
72
"description": "The note's slug, unique within its wiki. Use with wiki.",
71
73
"maxGraphemes": 256,
72
74
"maxLength": 2560,
73
75
"type": "string"
74
76
},
75
77
"uri": {
76
78
"description": "AT-URI of the note record. Supply this, or wiki and slug.",
77
79
"format": "at-uri",
78
80
"type": "string"
79
81
},
80
82
"wiki": {
81
83
"description": "AT-URI of the wiki the note belongs to. Use with slug.",
82
84
"format": "at-uri",
83
85
"type": "string"
84
86
}
85
87
},
86
88
"type": "params"
87
89
},
88
90
"type": "query"
89
91
}
90
92
},
91
93
"id": "wiki.lichen.getNote",
92
94
"lexicon": 1
93
95
}