dev.knotless.getPreferences
Schema Diff
+3 -1
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- ConstraintTightened ConstraintTightened { vertex_id: "dev.knotless.getPreferences#notificationReason.reason", sort: "knownValues", old_value: "[\"star\",\"follow\",\"pull\",\"issue\",\"comment\"]", new_value: "[\"star\",\"follow\",\"pull\",\"issue\",\"comment\",\"mention\",\"review-requested\"]" }
Migration Guidance
Constraint Changes
- ConstraintTightened ConstraintTightened { vertex_id: "dev.knotless.getPreferences#notificationReason.reason", sort: "knownValues", old_value: "[\"star\",\"follow\",\"pull\",\"issue\",\"comment\"]", new_value: "[\"star\",\"follow\",\"pull\",\"issue\",\"comment\",\"mention\",\"review-requested\"]" }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"appearancePref": {
5
5
"description": "How the pages are drawn for the account.",
6
6
"properties": {
7
7
"theme": {
8
8
"description": "The colours the pages are drawn in, as their Appearance settings name them. Absent, or one the pages do not know, they follow the system's light or dark.",
9
9
"knownValues": [
10
10
"light",
11
11
"dark",
12
12
"latte",
13
13
"mocha",
14
14
"dracula",
15
15
"pckt",
16
16
"plyr",
17
17
"blacksky"
18
18
],
19
19
"maxLength": 64,
20
20
"type": "string"
21
21
}
22
22
},
23
23
"type": "object"
24
24
},
25
25
"main": {
26
26
"description": "The asking account's preferences, as the appview keeps them, apart from any record: one of each kind, of those it has set, and always its notifications, which dev.knotless.listNotifications and getUnreadCount follow. A kind it has not set a reader takes as its default. The pages' login copies what they act on into the browser. Requires authentication: a service token, or the session cookie the pages' login sets.",
27
27
"errors": [
28
28
{
29
29
"description": "No account asks.",
30
30
"name": "AuthenticationRequired"
31
31
},
32
32
{
33
33
"description": "This appview keeps no index, so it keeps no preferences.",
34
34
"name": "NotFound"
35
35
}
36
36
],
37
37
"output": {
38
38
"encoding": "application/json",
39
39
"schema": {
40
40
"ref": "#preferences",
41
41
"type": "ref"
42
42
}
43
43
},
44
44
"type": "query"
45
45
},
46
46
"notificationPref": {
47
47
"description": "Which notifications the account hears of. Until it says, every reason, from anyone.",
48
48
"properties": {
49
49
"followedOnly": {
50
50
"description": "Whether it hears only of what accounts it follows on knotless did. Not, when absent.",
51
51
"type": "boolean"
52
52
},
53
53
"reasons": {
54
54
"description": "Reasons a notification is given for, each on or off. Given back, every one dev.knotless.listNotifications gives; set, one not named is on.",
55
55
"items": {
56
56
"ref": "#notificationReason",
57
57
"type": "ref"
58
58
},
59
59
"maxLength": 64,
60
60
"type": "array"
61
61
}
62
62
},
63
63
"type": "object"
64
64
},
65
65
"notificationReason": {
66
66
"description": "Whether an account hears of one reason's notifications.",
67
67
"properties": {
68
68
"enabled": {
69
69
"description": "Whether it hears of them.",
70
70
"type": "boolean"
71
71
},
72
72
"reason": {
73
73
"description": "A reason, as dev.knotless.listNotifications#notification gives it.",
74
74
"knownValues": [
75
75
"star",
76
76
"follow",
77
77
"pull",
78
78
"issue",
79
-
"comment"
79
+
"comment",
80
+
"mention",
81
+
"review-requested"
80
82
],
81
83
"maxLength": 64,
82
84
"type": "string"
83
85
}
84
86
},
85
87
"required": [
86
88
"reason",
87
89
"enabled"
88
90
],
89
91
"type": "object"
90
92
},
91
93
"preferences": {
92
94
"description": "An account's preferences, each of a kind.",
93
95
"properties": {
94
96
"preferences": {
95
97
"description": "At most one of each kind. Kinds unknown to a reader are passed over.",
96
98
"items": {
97
99
"refs": [
98
100
"#appearancePref",
99
101
"#notificationPref"
100
102
],
101
103
"type": "union"
102
104
},
103
105
"maxLength": 32,
104
106
"type": "array"
105
107
}
106
108
},
107
109
"required": [
108
110
"preferences"
109
111
],
110
112
"type": "object"
111
113
}
112
114
},
113
115
"description": "The asking account's preferences, of how knotless is shown to it.",
114
116
"id": "dev.knotless.getPreferences",
115
117
"lexicon": 1
116
118
}