social.colibri.beta.community.defs
Schema Diff
+40 -0
Compatibility Analysis
Breaking Changes Detected
2 breaking changes, 13 non-breaking changes.
Breaking Changes (2)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView", src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.name", kind: "prop", name: Some("name") }
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView", src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.did", kind: "prop", name: Some("did") }
Non-Breaking Changes (13)
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.channelCount" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.description" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.did" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.handle" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.memberCount" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.name" }
- AddedVertex AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.viewerIsAdmin" }
- AddedEdge AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.channelCount", kind: "prop", name: Some("channelCount") }
- AddedEdge AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.description", kind: "prop", name: Some("description") }
- AddedEdge AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.handle", kind: "prop", name: Some("handle") }
- AddedEdge AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.memberCount", kind: "prop", name: Some("memberCount") }
- AddedEdge AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.viewerIsAdmin", kind: "prop", name: Some("viewerIsAdmin") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.channelCount" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.description" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.did" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.handle" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.memberCount" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.name" }AddedVertex { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView.viewerIsAdmin" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView", src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.name", kind: "prop", name: Some("name") }
- Breaking: RequiredEdgeAdded { vertex_id: "social.colibri.beta.community.defs#legacyCommunityView", src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.did", kind: "prop", name: Some("did") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.channelCount", kind: "prop", name: Some("channelCount") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.description", kind: "prop", name: Some("description") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.handle", kind: "prop", name: Some("handle") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.memberCount", kind: "prop", name: Some("memberCount") }
- Non-breaking: AddedEdge { src: "social.colibri.beta.community.defs#legacyCommunityView", tgt: "social.colibri.beta.community.defs#legacyCommunityView.viewerIsAdmin", kind: "prop", name: Some("viewerIsAdmin") }
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
312
"managingApp",
313
313
"requiresApprovalToJoin",
314
314
"linkEmbeds",
315
315
"viewer"
316
316
],
317
317
"properties": {
318
318
"did": {
319
319
"type": "string",
320
320
"format": "did",
321
321
"description": "The community's DID, which is the authority for all of its spaces."
322
322
},
323
323
"name": {
324
324
"type": "string",
325
325
"description": "The community's name."
326
326
},
327
327
"banner": {
328
328
"type": "string",
329
329
"format": "uri",
330
330
"description": "URL of the community's banner, served by this AppView's blob proxy."
331
331
},
332
332
"handle": {
333
333
"type": "string",
334
334
"format": "handle",
335
335
"description": "The community's handle."
336
336
},
337
337
"viewer": {
338
338
"ref": "#viewerState",
339
339
"type": "ref",
340
340
"description": "The requesting user's relationship to this community."
341
341
},
342
342
"picture": {
343
343
"type": "string",
344
344
"format": "uri",
345
345
"description": "URL of the community's icon, served by this AppView's blob proxy."
346
346
},
347
347
"labelers": {
348
348
"type": "array",
349
349
"items": {
350
350
"type": "string",
351
351
"format": "did",
352
352
"description": "A labeler."
353
353
},
354
354
"description": "DIDs whose labels this community honours."
355
355
},
356
356
"linkEmbeds": {
357
357
"type": "boolean",
358
358
"description": "Whether link previews are shown by default."
359
359
},
360
360
"description": {
361
361
"type": "string",
362
362
"description": "The community's description."
363
363
},
364
364
"managingApp": {
365
365
"type": "string",
366
366
"format": "did",
367
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
368
},
369
369
"memberCount": {
370
370
"type": "integer",
371
371
"description": "Number of admitted members."
372
372
},
373
373
"migratedFrom": {
374
374
"type": "string",
375
375
"format": "at-uri",
376
376
"description": "The repo-backed community this one replaces, if any."
377
377
},
378
378
"requiresApprovalToJoin": {
379
379
"type": "boolean",
380
380
"description": "Whether joining produces an application to approve."
381
381
}
382
382
},
383
383
"description": "A community as the AppView serves it."
384
384
},
385
385
"invitationView": {
386
386
"type": "object",
387
387
"required": [
388
388
"code",
389
389
"createdBy",
390
390
"active",
391
391
"createdAt"
392
392
],
393
393
"properties": {
394
394
"code": {
395
395
"type": "string",
396
396
"description": "The invitation code."
397
397
},
398
398
"uses": {
399
399
"type": "integer",
400
400
"description": "How many times it has been redeemed."
401
401
},
402
402
"active": {
403
403
"type": "boolean",
404
404
"description": "Whether it can still be redeemed."
405
405
},
406
406
"maxUses": {
407
407
"type": "integer",
408
408
"description": "How many times it may be redeemed, if limited."
409
409
},
410
410
"createdAt": {
411
411
"type": "string",
412
412
"format": "datetime",
413
413
"description": "When it was created."
414
414
},
415
415
"createdBy": {
416
416
"type": "string",
417
417
"format": "did",
418
418
"description": "Who created it."
419
419
},
420
420
"expiresAt": {
421
421
"type": "string",
422
422
"format": "datetime",
423
423
"description": "When it stops being redeemable, if ever."
424
424
}
425
425
},
426
426
"description": "An invitation code."
427
427
},
428
428
"moderationView": {
429
429
"type": "object",
430
430
"required": [
431
431
"rkey",
432
432
"action",
433
433
"subject",
434
434
"createdBy",
435
435
"createdAt"
436
436
],
437
437
"properties": {
438
438
"rkey": {
439
439
"type": "string",
440
440
"format": "record-key",
441
441
"description": "The log entry's record key."
442
442
},
443
443
"action": {
444
444
"type": "string",
445
445
"description": "The action taken.",
446
446
"knownValues": [
447
447
"ban",
448
448
"unban",
449
449
"kick"
450
450
]
451
451
},
452
452
"reason": {
453
453
"type": "string",
454
454
"maxLength": 512,
455
455
"description": "Human-readable reason."
456
456
},
457
457
"subject": {
458
458
"ref": "social.colibri.beta.actor.defs#profileView",
459
459
"type": "ref",
460
460
"description": "Who it was taken against."
461
461
},
462
462
"createdAt": {
463
463
"type": "string",
464
464
"format": "datetime",
465
465
"description": "When it was taken."
466
466
},
467
467
"createdBy": {
468
468
"type": "string",
469
469
"format": "did",
470
470
"description": "Which moderator took it."
471
471
}
472
472
},
473
473
"description": "An entry in a community's moderation log."
474
474
},
475
475
"applicationView": {
476
476
"type": "object",
477
477
"required": [
478
478
"actor",
479
479
"createdAt",
480
480
"dismissed"
481
481
],
482
482
"properties": {
483
483
"actor": {
484
484
"ref": "social.colibri.beta.actor.defs#profileView",
485
485
"type": "ref",
486
486
"description": "The applicant."
487
487
},
488
488
"createdAt": {
489
489
"type": "string",
490
490
"format": "datetime",
491
491
"description": "When the application was made."
492
492
},
493
493
"dismissed": {
494
494
"type": "boolean",
495
495
"description": "Whether a moderator has hidden this from the active queue."
496
496
}
497
497
},
498
498
"description": "A pending request to join a community that requires approval."
499
499
},
500
500
"bannedActorView": {
501
501
"type": "object",
502
502
"required": [
503
503
"actor",
504
504
"bannedBy",
505
505
"bannedAt"
506
506
],
507
507
"properties": {
508
508
"actor": {
509
509
"ref": "social.colibri.beta.actor.defs#profileView",
510
510
"type": "ref",
511
511
"description": "The banned member."
512
512
},
513
513
"reason": {
514
514
"type": "string",
515
515
"maxLength": 512,
516
516
"description": "Why they were banned."
517
517
},
518
518
"bannedAt": {
519
519
"type": "string",
520
520
"format": "datetime",
521
521
"description": "When the ban took effect."
522
522
},
523
523
"bannedBy": {
524
524
"type": "string",
525
525
"format": "did",
526
526
"description": "Which moderator banned them."
527
527
}
528
528
},
529
529
"description": "A member who is currently banned from a community. Derived from the moderation log, which records bans and unbans as separate entries."
530
530
},
531
531
"channelViewerState": {
532
532
"type": "object",
533
533
"required": [
534
534
"canRead",
535
535
"canPost"
536
536
],
537
537
"properties": {
538
538
"canPost": {
539
539
"type": "boolean",
540
540
"description": "Whether the user may post in this channel."
541
541
},
542
542
"canRead": {
543
543
"type": "boolean",
544
544
"description": "Whether the user may read this channel."
545
545
},
546
546
"permissions": {
547
547
"type": "array",
548
548
"items": {
549
549
"type": "string",
550
550
"description": "A permission identifier."
551
551
},
552
552
"description": "Effective permissions in this channel, after per-channel role overrides."
553
553
}
554
554
},
555
555
"description": "The requesting user's access to a channel."
556
556
},
557
+
"legacyCommunityView": {
558
+
"type": "object",
559
+
"required": [
560
+
"did",
561
+
"name"
562
+
],
563
+
"properties": {
564
+
"did": {
565
+
"type": "string",
566
+
"format": "did",
567
+
"description": "The legacy community's DID, which becomes the authority for its spaces once migrated."
568
+
},
569
+
"name": {
570
+
"type": "string",
571
+
"description": "The community's name."
572
+
},
573
+
"handle": {
574
+
"type": "string",
575
+
"format": "handle",
576
+
"description": "The community's handle, when its DID document still resolves one."
577
+
},
578
+
"description": {
579
+
"type": "string",
580
+
"description": "The community's description."
581
+
},
582
+
"memberCount": {
583
+
"type": "integer",
584
+
"description": "How many member records the legacy repo holds."
585
+
},
586
+
"channelCount": {
587
+
"type": "integer",
588
+
"description": "How many channel records the legacy repo holds. Migration recreates one space per channel."
589
+
},
590
+
"viewerIsAdmin": {
591
+
"type": "boolean",
592
+
"description": "Whether the requesting user may migrate this community. Only an administrator of the legacy community can."
593
+
}
594
+
},
595
+
"description": "A repo-backed community that has not been migrated onto spaces yet, as read live from its own public repo. This is not an indexed view: the AppView holds nothing about a community until it is migrated."
596
+
},
557
597
"roleChannelOverride": {
558
598
"type": "object",
559
599
"required": [
560
600
"channel"
561
601
],
562
602
"properties": {
563
603
"deny": {
564
604
"type": "array",
565
605
"items": {
566
606
"type": "string",
567
607
"description": "A permission identifier."
568
608
},
569
609
"description": "Permissions denied here."
570
610
},
571
611
"allow": {
572
612
"type": "array",
573
613
"items": {
574
614
"type": "string",
575
615
"description": "A permission identifier."
576
616
},
577
617
"description": "Permissions granted here."
578
618
},
579
619
"channel": {
580
620
"type": "string",
581
621
"format": "record-key",
582
622
"description": "The channel's space key."
583
623
}
584
624
},
585
625
"description": "Allow and deny lists scoped to one channel."
586
626
}
587
627
},
588
628
"$type": "com.atproto.lexicon.schema",
589
629
"lexicon": 1
590
630
}