com.getorbyt.community.setAnnouncement
Schema Diff
+2 -2
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Sets or clears the Community's announcement banner. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.",
5
+
"description": "Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.",
6
6
"errors": [
7
7
{
8
8
"name": "AuthenticationRequired"
9
9
},
10
10
{
11
11
"name": "CommunityNotFound"
12
12
},
13
13
{
14
14
"name": "InsufficientRole"
15
15
},
16
16
{
17
17
"name": "InvalidRequest"
18
18
}
19
19
],
20
20
"input": {
21
21
"encoding": "application/json",
22
22
"schema": {
23
23
"properties": {
24
24
"community": {
25
25
"format": "at-uri",
26
26
"type": "string"
27
27
},
28
28
"text": {
29
-
"description": "The banner text. Absent or blank clears the announcement.",
29
+
"description": "The announcement text. Absent or blank clears the announcement.",
30
30
"maxGraphemes": 300,
31
31
"maxLength": 3000,
32
32
"type": "string"
33
33
}
34
34
},
35
35
"required": [
36
36
"community"
37
37
],
38
38
"type": "object"
39
39
}
40
40
},
41
41
"output": {
42
42
"encoding": "application/json",
43
43
"schema": {
44
44
"properties": {
45
45
"announcement": {
46
46
"description": "The announcement now. Absent once cleared.",
47
47
"ref": "com.getorbyt.community.defs#announcementView",
48
48
"type": "ref"
49
49
},
50
50
"changed": {
51
51
"type": "boolean"
52
52
}
53
53
},
54
54
"required": [
55
55
"changed"
56
56
],
57
57
"type": "object"
58
58
}
59
59
},
60
60
"type": "procedure"
61
61
}
62
62
},
63
63
"id": "com.getorbyt.community.setAnnouncement",
64
64
"lexicon": 1
65
65
}