social.colibri.beta.community.defs
Schema Diff
+6 -0
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 1 non-breaking change.
Breaking Changes (1)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#communityView", src: "social.colibri.beta.community.defs#communityView", tgt: "social.colibri.beta.community.defs#communityView.managingApp", kind: "prop", name: Some("managingApp") }
Non-Breaking Changes (1)
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#communityView.managingApp" }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "social.colibri.beta.community.defs#communityView.managingApp" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#communityView", src: "social.colibri.beta.community.defs#communityView", tgt: "social.colibri.beta.community.defs#communityView.managingApp", kind: "prop", name: Some("managingApp") }
1
1
{
2
2
"id": "social.colibri.beta.community.defs",
3
3
"defs": {
4
4
"roleView": {
5
5
"type": "object",
6
6
"required": [
7
7
"rkey",
8
8
"name",
9
9
"permissions",
10
10
"position"
11
11
],
12
12
"properties": {
13
13
"name": {
14
14
"type": "string",
15
15
"description": "Display name."
16
16
},
17
17
"rkey": {
18
18
"type": "string",
19
19
"format": "record-key",
20
20
"description": "The role's record key."
21
21
},
22
22
"color": {
23
23
"type": "string",
24
24
"maxLength": 7,
25
25
"description": "Hex colour as #rrggbb."
26
26
},
27
27
"hoisted": {
28
28
"type": "boolean",
29
29
"description": "Whether holders are listed separately."
30
30
},
31
31
"position": {
32
32
"type": "integer",
33
33
"description": "Hierarchy position. Higher outranks lower."
34
34
},
35
35
"protected": {
36
36
"type": "boolean",
37
37
"description": "Whether the role is exempt from modification and deletion."
38
38
},
39
39
"memberCount": {
40
40
"type": "integer",
41
41
"description": "Number of members holding this role."
42
42
},
43
43
"mentionable": {
44
44
"type": "boolean",
45
45
"description": "Whether @role mentions resolve to this role."
46
46
},
47
47
"permissions": {
48
48
"type": "array",
49
49
"items": {
50
50
"type": "string",
51
51
"description": "A permission identifier."
52
52
},
53
53
"description": "Permissions granted."
54
54
},
55
55
"channelOverrides": {
56
56
"type": "array",
57
57
"items": {
58
58
"ref": "#roleChannelOverride",
59
59
"type": "ref"
60
60
},
61
61
"description": "Per-channel overrides."
62
62
}
63
63
},
64
64
"description": "A role."
65
65
},
66
66
"labelView": {
67
67
"type": "object",
68
68
"required": [
69
69
"src",
70
70
"val",
71
71
"createdAt"
72
72
],
73
73
"properties": {
74
74
"src": {
75
75
"type": "string",
76
76
"format": "did",
77
77
"description": "The labeler that applied it."
78
78
},
79
79
"val": {
80
80
"type": "string",
81
81
"description": "The label value."
82
82
},
83
83
"scope": {
84
84
"type": "array",
85
85
"items": {
86
86
"type": "string",
87
87
"format": "uri",
88
88
"description": "A URI within the labelled record."
89
89
},
90
90
"description": "What the label narrows to."
91
91
},
92
92
"reason": {
93
93
"type": "string",
94
94
"maxLength": 512,
95
95
"description": "Human-readable reason."
96
96
},
97
97
"createdAt": {
98
98
"type": "string",
99
99
"format": "datetime",
100
100
"description": "When it was applied."
101
101
}
102
102
},
103
103
"description": "A label applied to a record."
104
104
},
105
105
"memberView": {
106
106
"type": "object",
107
107
"required": [
108
108
"actor",
109
109
"roles",
110
110
"joinedAt"
111
111
],
112
112
"properties": {
113
113
"actor": {
114
114
"ref": "social.colibri.beta.actor.defs#profileView",
115
115
"type": "ref",
116
116
"description": "The member."
117
117
},
118
118
"roles": {
119
119
"type": "array",
120
120
"items": {
121
121
"type": "string",
122
122
"format": "record-key",
123
123
"description": "A role."
124
124
},
125
125
"description": "Roles held, highest first."
126
126
},
127
127
"joinedAt": {
128
128
"type": "string",
129
129
"format": "datetime",
130
130
"description": "When the member was admitted."
131
131
},
132
132
"nickname": {
133
133
"type": "string",
134
134
"maxLength": 32,
135
135
"description": "Per-community display name override."
136
136
}
137
137
},
138
138
"description": "An admitted community member."
139
139
},
140
140
"channelView": {
141
141
"type": "object",
142
142
"required": [
143
143
"space",
144
144
"type",
145
145
"name",
146
146
"viewer"
147
147
],
148
148
"properties": {
149
149
"name": {
150
150
"type": "string",
151
151
"description": "The channel's name."
152
152
},
153
153
"type": {
154
154
"type": "string",
155
155
"description": "The channel's space type.",
156
156
"knownValues": [
157
157
"social.colibri.beta.channel.text",
158
158
"social.colibri.beta.channel.voice"
159
159
]
160
160
},
161
161
"space": {
162
162
"type": "string",
163
163
"format": "space-ref",
164
164
"description": "The channel's space, which is its identity."
165
165
},
166
166
"viewer": {
167
167
"ref": "#channelViewerState",
168
168
"type": "ref",
169
169
"description": "The requesting user's access to this channel."
170
170
},
171
171
"private": {
172
172
"type": "boolean",
173
173
"description": "Whether the channel restricts who may read it, rather than only who may post."
174
174
},
175
175
"category": {
176
176
"type": "string",
177
177
"format": "record-key",
178
178
"description": "The category this channel is listed under."
179
179
},
180
180
"ownerOnly": {
181
181
"type": "boolean",
182
182
"description": "Whether only admins may post."
183
183
},
184
184
"linkEmbeds": {
185
185
"type": "boolean",
186
186
"description": "Whether link previews are shown here."
187
187
},
188
188
"description": {
189
189
"type": "string",
190
190
"description": "The channel's topic."
191
191
},
192
192
"allowedRoles": {
193
193
"type": "array",
194
194
"items": {
195
195
"type": "string",
196
196
"format": "record-key",
197
197
"description": "A role."
198
198
},
199
199
"description": "Roles allowed to post."
200
200
},
201
201
"migratedFrom": {
202
202
"type": "string",
203
203
"format": "at-uri",
204
204
"description": "The legacy channel whose history is served alongside this one."
205
205
},
206
206
"allowedMembers": {
207
207
"type": "array",
208
208
"items": {
209
209
"type": "string",
210
210
"format": "did",
211
211
"description": "A member."
212
212
},
213
213
"description": "Members allowed to post."
214
214
},
215
215
"visibleToRoles": {
216
216
"type": "array",
217
217
"items": {
218
218
"type": "string",
219
219
"format": "record-key",
220
220
"description": "A role."
221
221
},
222
222
"description": "Roles that may read this channel. Empty means every member may."
223
223
},
224
224
"visibleToMembers": {
225
225
"type": "array",
226
226
"items": {
227
227
"type": "string",
228
228
"format": "did",
229
229
"description": "A member."
230
230
},
231
231
"description": "Members that may read this channel beyond visibleToRoles."
232
232
}
233
233
},
234
234
"description": "A channel as the AppView serves it. The channel's identity is its space."
235
235
},
236
236
"viewerState": {
237
237
"type": "object",
238
238
"required": [
239
239
"isMember"
240
240
],
241
241
"properties": {
242
242
"roles": {
243
243
"type": "array",
244
244
"items": {
245
245
"type": "string",
246
246
"format": "record-key",
247
247
"description": "A role the user holds."
248
248
},
249
249
"description": "Roles the user holds."
250
250
},
251
251
"isOwner": {
252
252
"type": "boolean",
253
253
"description": "Whether the user holds a protected role."
254
254
},
255
255
"isBanned": {
256
256
"type": "boolean",
257
257
"description": "Whether the user is banned."
258
258
},
259
259
"isMember": {
260
260
"type": "boolean",
261
261
"description": "Whether the user holds a member record."
262
262
},
263
263
"permissions": {
264
264
"type": "array",
265
265
"items": {
266
266
"type": "string",
267
267
"description": "A permission identifier."
268
268
},
269
269
"description": "Effective community-wide permissions."
270
270
},
271
271
"applicationPending": {
272
272
"type": "boolean",
273
273
"description": "Whether the user has an unapproved application."
274
274
}
275
275
},
276
276
"description": "The requesting user's relationship to a community."
277
277
},
278
278
"categoryView": {
279
279
"type": "object",
280
280
"required": [
281
281
"rkey",
282
282
"name",
283
283
"channels"
284
284
],
285
285
"properties": {
286
286
"name": {
287
287
"type": "string",
288
288
"description": "The category's name."
289
289
},
290
290
"rkey": {
291
291
"type": "string",
292
292
"format": "record-key",
293
293
"description": "The category's record key."
294
294
},
295
295
"channels": {
296
296
"type": "array",
297
297
"items": {
298
298
"ref": "#channelView",
299
299
"type": "ref"
300
300
},
301
301
"description": "Channels in display order."
302
302
}
303
303
},
304
304
"description": "A category and the channels in it."
305
305
},
306
306
"communityView": {
307
307
"type": "object",
308
308
"required": [
309
309
"did",
310
310
"handle",
311
311
"name",
312
+
"managingApp",
312
313
"requiresApprovalToJoin",
313
314
"linkEmbeds",
314
315
"viewer"
315
316
],
316
317
"properties": {
317
318
"did": {
318
319
"type": "string",
319
320
"format": "did",
320
321
"description": "The community's DID, which is the authority for all of its spaces."
321
322
},
322
323
"name": {
323
324
"type": "string",
324
325
"description": "The community's name."
325
326
},
326
327
"banner": {
327
328
"type": "string",
328
329
"format": "uri",
329
330
"description": "URL of the community's banner, served by this AppView's blob proxy."
330
331
},
331
332
"handle": {
332
333
"type": "string",
333
334
"format": "handle",
334
335
"description": "The community's handle."
335
336
},
336
337
"viewer": {
337
338
"ref": "#viewerState",
338
339
"type": "ref",
339
340
"description": "The requesting user's relationship to this community."
340
341
},
341
342
"picture": {
342
343
"type": "string",
343
344
"format": "uri",
344
345
"description": "URL of the community's icon, served by this AppView's blob proxy."
345
346
},
346
347
"labelers": {
347
348
"type": "array",
348
349
"items": {
349
350
"type": "string",
350
351
"format": "did",
351
352
"description": "A labeler."
352
353
},
353
354
"description": "DIDs whose labels this community honours."
354
355
},
355
356
"linkEmbeds": {
356
357
"type": "boolean",
357
358
"description": "Whether link previews are shown by default."
358
359
},
359
360
"description": {
360
361
"type": "string",
361
362
"description": "The community's description."
362
363
},
364
+
"managingApp": {
365
+
"type": "string",
366
+
"format": "did",
367
+
"description": "The AppView that manages this community's spaces. When it is not the AppView that served this view, the client must talk to that AppView for this community's reads, writes, events and voice."
368
+
},
363
369
"memberCount": {
364
370
"type": "integer",
365
371
"description": "Number of admitted members."
366
372
},
367
373
"migratedFrom": {
368
374
"type": "string",
369
375
"format": "at-uri",
370
376
"description": "The repo-backed community this one replaces, if any."
371
377
},
372
378
"requiresApprovalToJoin": {
373
379
"type": "boolean",
374
380
"description": "Whether joining produces an application to approve."
375
381
}
376
382
},
377
383
"description": "A community as the AppView serves it."
378
384
},
379
385
"invitationView": {
380
386
"type": "object",
381
387
"required": [
382
388
"code",
383
389
"createdBy",
384
390
"active",
385
391
"createdAt"
386
392
],
387
393
"properties": {
388
394
"code": {
389
395
"type": "string",
390
396
"description": "The invitation code."
391
397
},
392
398
"uses": {
393
399
"type": "integer",
394
400
"description": "How many times it has been redeemed."
395
401
},
396
402
"active": {
397
403
"type": "boolean",
398
404
"description": "Whether it can still be redeemed."
399
405
},
400
406
"maxUses": {
401
407
"type": "integer",
402
408
"description": "How many times it may be redeemed, if limited."
403
409
},
404
410
"createdAt": {
405
411
"type": "string",
406
412
"format": "datetime",
407
413
"description": "When it was created."
408
414
},
409
415
"createdBy": {
410
416
"type": "string",
411
417
"format": "did",
412
418
"description": "Who created it."
413
419
},
414
420
"expiresAt": {
415
421
"type": "string",
416
422
"format": "datetime",
417
423
"description": "When it stops being redeemable, if ever."
418
424
}
419
425
},
420
426
"description": "An invitation code."
421
427
},
422
428
"moderationView": {
423
429
"type": "object",
424
430
"required": [
425
431
"rkey",
426
432
"action",
427
433
"subject",
428
434
"createdBy",
429
435
"createdAt"
430
436
],
431
437
"properties": {
432
438
"rkey": {
433
439
"type": "string",
434
440
"format": "record-key",
435
441
"description": "The log entry's record key."
436
442
},
437
443
"action": {
438
444
"type": "string",
439
445
"description": "The action taken.",
440
446
"knownValues": [
441
447
"ban",
442
448
"unban",
443
449
"kick"
444
450
]
445
451
},
446
452
"reason": {
447
453
"type": "string",
448
454
"maxLength": 512,
449
455
"description": "Human-readable reason."
450
456
},
451
457
"subject": {
452
458
"ref": "social.colibri.beta.actor.defs#profileView",
453
459
"type": "ref",
454
460
"description": "Who it was taken against."
455
461
},
456
462
"createdAt": {
457
463
"type": "string",
458
464
"format": "datetime",
459
465
"description": "When it was taken."
460
466
},
461
467
"createdBy": {
462
468
"type": "string",
463
469
"format": "did",
464
470
"description": "Which moderator took it."
465
471
}
466
472
},
467
473
"description": "An entry in a community's moderation log."
468
474
},
469
475
"applicationView": {
470
476
"type": "object",
471
477
"required": [
472
478
"actor",
473
479
"createdAt",
474
480
"dismissed"
475
481
],
476
482
"properties": {
477
483
"actor": {
478
484
"ref": "social.colibri.beta.actor.defs#profileView",
479
485
"type": "ref",
480
486
"description": "The applicant."
481
487
},
482
488
"createdAt": {
483
489
"type": "string",
484
490
"format": "datetime",
485
491
"description": "When the application was made."
486
492
},
487
493
"dismissed": {
488
494
"type": "boolean",
489
495
"description": "Whether a moderator has hidden this from the active queue."
490
496
}
491
497
},
492
498
"description": "A pending request to join a community that requires approval."
493
499
},
494
500
"bannedActorView": {
495
501
"type": "object",
496
502
"required": [
497
503
"actor",
498
504
"bannedBy",
499
505
"bannedAt"
500
506
],
501
507
"properties": {
502
508
"actor": {
503
509
"ref": "social.colibri.beta.actor.defs#profileView",
504
510
"type": "ref",
505
511
"description": "The banned member."
506
512
},
507
513
"reason": {
508
514
"type": "string",
509
515
"maxLength": 512,
510
516
"description": "Why they were banned."
511
517
},
512
518
"bannedAt": {
513
519
"type": "string",
514
520
"format": "datetime",
515
521
"description": "When the ban took effect."
516
522
},
517
523
"bannedBy": {
518
524
"type": "string",
519
525
"format": "did",
520
526
"description": "Which moderator banned them."
521
527
}
522
528
},
523
529
"description": "A member who is currently banned from a community. Derived from the moderation log, which records bans and unbans as separate entries."
524
530
},
525
531
"channelViewerState": {
526
532
"type": "object",
527
533
"required": [
528
534
"canRead",
529
535
"canPost"
530
536
],
531
537
"properties": {
532
538
"canPost": {
533
539
"type": "boolean",
534
540
"description": "Whether the user may post in this channel."
535
541
},
536
542
"canRead": {
537
543
"type": "boolean",
538
544
"description": "Whether the user may read this channel."
539
545
},
540
546
"permissions": {
541
547
"type": "array",
542
548
"items": {
543
549
"type": "string",
544
550
"description": "A permission identifier."
545
551
},
546
552
"description": "Effective permissions in this channel, after per-channel role overrides."
547
553
}
548
554
},
549
555
"description": "The requesting user's access to a channel."
550
556
},
551
557
"roleChannelOverride": {
552
558
"type": "object",
553
559
"required": [
554
560
"channel"
555
561
],
556
562
"properties": {
557
563
"deny": {
558
564
"type": "array",
559
565
"items": {
560
566
"type": "string",
561
567
"description": "A permission identifier."
562
568
},
563
569
"description": "Permissions denied here."
564
570
},
565
571
"allow": {
566
572
"type": "array",
567
573
"items": {
568
574
"type": "string",
569
575
"description": "A permission identifier."
570
576
},
571
577
"description": "Permissions granted here."
572
578
},
573
579
"channel": {
574
580
"type": "string",
575
581
"format": "record-key",
576
582
"description": "The channel's space key."
577
583
}
578
584
},
579
585
"description": "Allow and deny lists scoped to one channel."
580
586
}
581
587
},
582
588
"$type": "com.atproto.lexicon.schema",
583
589
"lexicon": 1
584
590
}