social.colibri.sync.subscribeHums
Schema Diff
+14 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 2 non-breaking changes.
Non-Breaking Changes (2)
- AddedVertex AddedVertex { vertex_id: "social.colibri.sync.subscribeHums:params" }
- AddedEdge AddedEdge { src: "social.colibri.sync.subscribeHums", tgt: "social.colibri.sync.subscribeHums:params", kind: "prop", name: Some("parameters") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "social.colibri.sync.subscribeHums:params" }
Additional Notes
- Non-breaking: AddedEdge { src: "social.colibri.sync.subscribeHums", tgt: "social.colibri.sync.subscribeHums:params", kind: "prop", name: Some("parameters") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "Egress-only WebSocket stream of Hums this AppView is relaying. Peers subscribe to receive off-protocol events for shared communities, optionally narrowing to declared `communities` (repeated query param). Requires inter-service auth (subprotocol-carried, as with subscribeEvents). Clients cannot send messages on this stream.",
6
6
"errors": [
7
7
{
8
+
"description": "Missing, malformed, or unverifiable service auth.",
8
9
"name": "AuthRequired"
9
10
},
10
11
{
11
12
"description": "Humming is disabled on this AppView.",
12
13
"name": "NotEnabled"
13
14
},
14
15
{
15
16
"description": "The hub is at its subscribeHums connection limit.",
16
17
"name": "TooManySubscribers"
17
18
}
18
19
],
19
20
"message": {
20
21
"schema": {
21
22
"refs": [
22
23
"lex:social.colibri.sync.subscribeEvents#humEnvelope"
23
24
],
24
25
"type": "union"
25
26
}
26
27
},
28
+
"parameters": {
29
+
"properties": {
30
+
"communities": {
31
+
"description": "DIDs of the communities the peer wants Hums for, repeated once per community. Narrowing only: the intersection with what the peer is authorised for is what gets streamed, so declaring a community grants nothing. Omit it entirely to receive every authorised community.",
32
+
"items": {
33
+
"format": "did",
34
+
"type": "string"
35
+
},
36
+
"type": "array"
37
+
}
38
+
},
39
+
"type": "params"
40
+
},
27
41
"type": "subscription"
28
42
}
29
43
},
30
44
"id": "social.colibri.sync.subscribeHums",
31
45
"lexicon": 1
32
46
}