wiki.lichen.getWiki
Schema Diff
+1 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "Get a wiki. Pass viewer to also get what that DID can do with it. Public wikis only. Takes a DID, so resolve a handle to one first with com.atproto.identity.resolveHandle.",
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
"createdAt": {
16
16
"description": "The wiki record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
17
17
"format": "datetime",
18
18
"type": "string"
19
19
},
20
20
"description": {
21
21
"type": "string"
22
22
},
23
23
"did": {
24
24
"format": "did",
25
25
"type": "string"
26
26
},
27
27
"homeSlug": {
28
-
"description": "The note shown as the wiki's front page. Each appview sets this itself, so another instance hosting the same wiki may answer differently.",
28
+
"description": "The note shown as the wiki's front page, as the wiki record's homeSlug names it.",
29
29
"type": "string"
30
30
},
31
31
"language": {
32
32
"type": "string"
33
33
},
34
34
"name": {
35
35
"type": "string"
36
36
},
37
37
"noteCount": {
38
38
"description": "How many notes listNotes returns. A note counts once its first revision is ingested.",
39
39
"type": "integer"
40
40
},
41
41
"slug": {
42
42
"type": "string"
43
43
},
44
44
"updatedAt": {
45
45
"description": "When this appview last saw the wiki or a note in it change. Observed locally, so appviews may legitimately disagree.",
46
46
"format": "datetime",
47
47
"type": "string"
48
48
},
49
49
"uri": {
50
50
"format": "at-uri",
51
51
"type": "string"
52
52
},
53
53
"viewer": {
54
54
"description": "Present only when the viewer parameter was supplied.",
55
55
"ref": "#viewerState",
56
56
"type": "ref"
57
57
}
58
58
},
59
59
"required": [
60
60
"uri",
61
61
"did",
62
62
"slug",
63
63
"name",
64
64
"description",
65
65
"language",
66
66
"noteCount",
67
67
"createdAt",
68
68
"updatedAt"
69
69
],
70
70
"type": "object"
71
71
}
72
72
},
73
73
"parameters": {
74
74
"properties": {
75
75
"did": {
76
76
"description": "Owner of the wiki. Use with slug.",
77
77
"format": "did",
78
78
"type": "string"
79
79
},
80
80
"slug": {
81
81
"description": "The wiki's slug, which is also its record key. Use with did.",
82
82
"format": "record-key",
83
83
"maxLength": 512,
84
84
"type": "string"
85
85
},
86
86
"uri": {
87
87
"description": "AT-URI of the wiki record. Supply this, or did and slug.",
88
88
"format": "at-uri",
89
89
"type": "string"
90
90
},
91
91
"viewer": {
92
92
"description": "Ask what this DID can do with the wiki. Check it before writing, because ingest keeps a revision only from a DID that can edit and drops the rest silently.",
93
93
"format": "did",
94
94
"type": "string"
95
95
}
96
96
},
97
97
"type": "params"
98
98
},
99
99
"type": "query"
100
100
},
101
101
"viewerState": {
102
102
"properties": {
103
103
"canWrite": {
104
104
"description": "Whether a wiki.lichen.noteRevision written by this DID would be accepted.",
105
105
"type": "boolean"
106
106
},
107
107
"did": {
108
108
"format": "did",
109
109
"type": "string"
110
110
},
111
111
"role": {
112
112
"description": "Present when the DID owns the wiki or holds a membership.",
113
113
"knownValues": [
114
114
"owner",
115
115
"admin",
116
116
"contributor",
117
117
"viewer"
118
118
],
119
119
"type": "string"
120
120
}
121
121
},
122
122
"required": [
123
123
"did",
124
124
"canWrite"
125
125
],
126
126
"type": "object"
127
127
}
128
128
},
129
129
"id": "wiki.lichen.getWiki",
130
130
"lexicon": 1
131
131
}