dev.knotless.listNotifications
Schema Diff
+7 -5
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- ConstraintTightened ConstraintTightened { vertex_id: "dev.knotless.listNotifications#notification.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.listNotifications#notification.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
"main": {
5
-
"description": "What others did that concerns the account asking, as the appview has indexed it, the latest first: stars of its repositories, follows of it, pulls and issues opened on its repositories, and comments and reviews on its pulls and issues, and on those it commented on, after it did. Leaves out its own doings, and accounts it blocked or that are taken down. Those of a private repository come from the appview's own index of its space, where its owner lets it keep one, while the account can read it. Requires authentication: a service token, or the session cookie the pages' login sets.",
5
+
"description": "What others did that concerns the account asking, as the appview has indexed it, the latest first: stars of its repositories, follows of it, pulls and issues opened on its repositories, comments and reviews on its pulls and issues, and on those it commented on, after it did, and pulls, issues and comments that mention it. One record is one notification: a comment that mentions the author of what it is on is heard of as a comment. Leaves out its own doings, and accounts it blocked or that are taken down. Those of a private repository come from the appview's own index of its space, where its owner lets it keep one, while the account can read it: a mention of someone who cannot is never heard of. Requires authentication: a service token, or the session cookie the pages' login sets.",
6
6
"errors": [
7
7
{
8
8
"description": "No account asks.",
9
9
"name": "AuthenticationRequired"
10
10
}
11
11
],
12
12
"output": {
13
13
"encoding": "application/json",
14
14
"schema": {
15
15
"properties": {
16
16
"cursor": {
17
17
"description": "Absent on the last page.",
18
18
"type": "string"
19
19
},
20
20
"notifications": {
21
21
"items": {
22
22
"ref": "#notification",
23
23
"type": "ref"
24
24
},
25
25
"type": "array"
26
26
},
27
27
"seenAt": {
28
28
"description": "When the account last said it had seen its notifications, if ever.",
29
29
"format": "datetime",
30
30
"type": "string"
31
31
}
32
32
},
33
33
"required": [
34
34
"notifications"
35
35
],
36
36
"type": "object"
37
37
}
38
38
},
39
39
"parameters": {
40
40
"properties": {
41
41
"cursor": {
42
42
"description": "Where the page before ended.",
43
43
"maxLength": 512,
44
44
"type": "string"
45
45
},
46
46
"limit": {
47
47
"default": 50,
48
48
"maximum": 100,
49
49
"minimum": 1,
50
50
"type": "integer"
51
51
}
52
52
},
53
53
"type": "params"
54
54
},
55
55
"type": "query"
56
56
},
57
57
"notification": {
58
58
"description": "One thing another account did that concerns the asker.",
59
59
"properties": {
60
60
"author": {
61
61
"ref": "dev.knotless.defs#actorView",
62
62
"type": "ref"
63
63
},
64
64
"createdAt": {
65
65
"format": "datetime",
66
66
"type": "string"
67
67
},
68
68
"isRead": {
69
69
"description": "Whether it is from before the asker last saw its notifications.",
70
70
"type": "boolean"
71
71
},
72
72
"reason": {
73
-
"description": "What it did: starred the asker's repository, followed the asker, opened a pull or an issue on its repository, or commented on its pull or issue, or on one it commented on.",
73
+
"description": "What it did: starred the asker's repository, followed the asker, opened a pull or an issue on its repository, commented on its pull or issue, or on one it commented on, mentioned the asker in a pull, an issue or a comment, or asked it to review a pull that is not a draft.",
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
"type": "string"
82
84
},
83
85
"reasonSubject": {
84
-
"description": "For a comment, the pull or issue it is on.",
86
+
"description": "For a comment, or a mention in one, the pull or issue it is on.",
85
87
"format": "at-uri",
86
88
"type": "string"
87
89
},
88
90
"repo": {
89
91
"description": "The repository it is about, under the name it has now, if any.",
90
92
"ref": "dev.knotless.defs#repoViewBasic",
91
93
"type": "ref"
92
94
},
93
95
"title": {
94
96
"description": "The title of the pull or issue it is, or is on.",
95
97
"type": "string"
96
98
},
97
99
"uri": {
98
-
"description": "The record it wrote: a star, a follow, a pull, an issue or a comment.",
100
+
"description": "The record it wrote: a star, a follow, a pull, an issue or a comment, or the pull, issue or comment that mentions the asker.",
99
101
"format": "at-uri",
100
102
"type": "string"
101
103
},
102
104
"verdict": {
103
105
"description": "For a comment that reviews a pull, what it found: `approve`, or `changes` to ask for changes.",
104
106
"knownValues": [
105
107
"approve",
106
108
"changes"
107
109
],
108
110
"type": "string"
109
111
}
110
112
},
111
113
"required": [
112
114
"uri",
113
115
"author",
114
116
"reason",
115
117
"isRead",
116
118
"createdAt"
117
119
],
118
120
"type": "object"
119
121
}
120
122
},
121
123
"description": "What others did that concerns the account asking.",
122
124
"id": "dev.knotless.listNotifications",
123
125
"lexicon": 1
124
126
}