social.colibri.beta.channel.listMessages
Schema Diff
+13 -4
Compatibility Analysis
Backward Compatible
Backward compatible. 6 non-breaking changes.
Non-Breaking Changes (6)
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.channel.listMessages:output.threads" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.channel.listMessages:output.threads:items" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.thread.defs#threadView" }
- AddedEdge AddedEdge { src: "social.colibri.beta.channel.listMessages:output", tgt: "social.colibri.beta.channel.listMessages:output.threads", kind: "prop", name: Some("threads") }
- AddedEdge AddedEdge { src: "social.colibri.beta.channel.listMessages:output.threads", tgt: "social.colibri.beta.channel.listMessages:output.threads:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "social.colibri.beta.channel.listMessages:output.threads:items", tgt: "social.colibri.beta.thread.defs#threadView", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "social.colibri.beta.channel.listMessages:output.threads" }AddedVertex { vertex_id: "social.colibri.beta.channel.listMessages:output.threads:items" }AddedVertex { vertex_id: "social.colibri.beta.thread.defs#threadView" }
Additional Notes
- Non-breaking: AddedEdge { src: "social.colibri.beta.channel.listMessages:output", tgt: "social.colibri.beta.channel.listMessages:output.threads", kind: "prop", name: Some("threads") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.channel.listMessages:output.threads", tgt: "social.colibri.beta.channel.listMessages:output.threads:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "social.colibri.beta.channel.listMessages:output.threads:items", tgt: "social.colibri.beta.thread.defs#threadView", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Lists messages in a channel, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy.",
5
+
"description": "Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.",
6
6
"errors": [
7
7
{
8
8
"description": "The request has no valid service auth.",
9
9
"name": "AuthRequired"
10
10
},
11
11
{
12
-
"description": "The requesting user may not read this channel.",
12
+
"description": "The requesting user may not read this channel or thread.",
13
13
"name": "Forbidden"
14
14
},
15
15
{
16
-
"description": "No channel matches the given space reference.",
16
+
"description": "No channel or thread matches the given space reference.",
17
17
"name": "ChannelNotFound"
18
18
}
19
19
],
20
20
"output": {
21
21
"encoding": "application/json",
22
22
"schema": {
23
23
"properties": {
24
24
"cursor": {
25
25
"description": "Pagination cursor for the next page.",
26
26
"type": "string"
27
27
},
28
28
"messages": {
29
29
"description": "The channel's messages.",
30
30
"items": {
31
31
"ref": "social.colibri.beta.channel.defs#messageView",
32
32
"type": "ref"
33
33
},
34
34
"type": "array"
35
+
},
36
+
"threads": {
37
+
"description": "Threads whose anchor message is in this page, so a client can draw a thread's marker under the message it was opened from without a second call. Threads the requesting user may not read are absent.",
38
+
"items": {
39
+
"description": "A thread.",
40
+
"ref": "social.colibri.beta.thread.defs#threadView",
41
+
"type": "ref"
42
+
},
43
+
"type": "array"
35
44
}
36
45
},
37
46
"required": [
38
47
"messages"
39
48
],
40
49
"type": "object"
41
50
}
42
51
},
43
52
"parameters": {
44
53
"properties": {
45
54
"channel": {
46
-
"description": "The channel to list messages from.",
55
+
"description": "The channel or thread to list messages from.",
47
56
"format": "space-ref",
48
57
"type": "string"
49
58
},
50
59
"cursor": {
51
60
"description": "Pagination cursor from a previous call.",
52
61
"type": "string"
53
62
},
54
63
"limit": {
55
64
"default": 50,
56
65
"description": "Maximum number of messages to return.",
57
66
"maximum": 100,
58
67
"minimum": 1,
59
68
"type": "integer"
60
69
},
61
70
"reverse": {
62
71
"default": false,
63
72
"description": "Whether to return the oldest messages first instead of the newest.",
64
73
"type": "boolean"
65
74
}
66
75
},
67
76
"required": [
68
77
"channel"
69
78
],
70
79
"type": "params"
71
80
},
72
81
"type": "query"
73
82
}
74
83
},
75
84
"id": "social.colibri.beta.channel.listMessages",
76
85
"lexicon": 1
77
86
}