space.highport.defs
Schema Diff
+4 -2
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- ConstraintTightened ConstraintTightened { vertex_id: "space.highport.defs#edgeReachStatus", sort: "knownValues", old_value: "[\"unknown\",\"routed\",\"foreign\",\"unreachable\"]", new_value: "[\"unknown\",\"routed\",\"foreign\",\"unreachable\",\"other-deployment\",\"unproven\"]" }
Migration Guidance
Constraint Changes
- ConstraintTightened ConstraintTightened { vertex_id: "space.highport.defs#edgeReachStatus", sort: "knownValues", old_value: "[\"unknown\",\"routed\",\"foreign\",\"unreachable\"]", new_value: "[\"unknown\",\"routed\",\"foreign\",\"unreachable\",\"other-deployment\",\"unproven\"]" }
1
1
{
2
2
"id": "space.highport.defs",
3
3
"defs": {
4
4
"jobView": {
5
5
"type": "object",
6
6
"required": [
7
7
"id",
8
8
"uri",
9
9
"action",
10
10
"state",
11
11
"attempts",
12
12
"scheduledAt"
13
13
],
14
14
"properties": {
15
15
"id": {
16
16
"type": "integer"
17
17
},
18
18
"uri": {
19
19
"type": "string"
20
20
},
21
21
"state": {
22
22
"type": "string"
23
23
},
24
24
"action": {
25
25
"type": "string"
26
26
},
27
27
"attempts": {
28
28
"type": "integer"
29
29
},
30
30
"lastError": {
31
31
"type": "string"
32
32
},
33
33
"startedAt": {
34
34
"type": "string",
35
35
"format": "datetime"
36
36
},
37
37
"finishedAt": {
38
38
"type": "string",
39
39
"format": "datetime"
40
40
},
41
41
"scheduledAt": {
42
42
"type": "string",
43
43
"format": "datetime"
44
44
}
45
45
}
46
46
},
47
47
"tlsView": {
48
48
"type": "object",
49
49
"required": [
50
50
"status"
51
51
],
52
52
"properties": {
53
53
"status": {
54
54
"ref": "#tlsStatus",
55
55
"type": "ref"
56
56
},
57
57
"issuedAt": {
58
58
"type": "string",
59
59
"format": "datetime"
60
60
},
61
61
"expiresAt": {
62
62
"type": "string",
63
63
"format": "datetime"
64
64
},
65
65
"lastError": {
66
66
"type": "string"
67
67
}
68
68
}
69
69
},
70
70
"siteView": {
71
71
"type": "object",
72
72
"required": [
73
73
"domain",
74
74
"did",
75
75
"uri",
76
76
"cid",
77
77
"rev",
78
78
"activatedAt",
79
79
"sourceKind"
80
80
],
81
81
"properties": {
82
82
"cid": {
83
83
"type": "string",
84
84
"format": "cid"
85
85
},
86
86
"did": {
87
87
"type": "string",
88
88
"format": "did"
89
89
},
90
90
"rev": {
91
91
"type": "string"
92
92
},
93
93
"uri": {
94
94
"type": "string",
95
95
"format": "at-uri"
96
96
},
97
97
"tile": {
98
98
"ref": "#tileView",
99
99
"type": "ref"
100
100
},
101
101
"space": {
102
102
"type": "string",
103
103
"format": "at-uri",
104
104
"description": "Present for a site published from a space; attribution survives the plane."
105
105
},
106
106
"domain": {
107
107
"type": "string"
108
108
},
109
109
"sourceKind": {
110
110
"type": "string",
111
111
"knownValues": [
112
112
"inline",
113
113
"tile"
114
114
]
115
115
},
116
116
"activatedAt": {
117
117
"type": "string",
118
118
"format": "datetime"
119
119
}
120
120
}
121
121
},
122
122
"tileView": {
123
123
"type": "object",
124
124
"required": [
125
125
"uri",
126
126
"cid",
127
127
"did",
128
128
"name",
129
129
"state",
130
130
"indexedAt"
131
131
],
132
132
"properties": {
133
133
"cid": {
134
134
"type": "string",
135
135
"format": "cid"
136
136
},
137
137
"did": {
138
138
"type": "string",
139
139
"format": "did"
140
140
},
141
141
"uri": {
142
142
"type": "string",
143
143
"format": "at-uri"
144
144
},
145
145
"name": {
146
146
"type": "string"
147
147
},
148
148
"space": {
149
149
"type": "string",
150
150
"format": "at-uri",
151
151
"description": "Present for a space tile; never on the public surface."
152
152
},
153
153
"state": {
154
154
"type": "string",
155
155
"knownValues": [
156
156
"indexing",
157
157
"ready",
158
158
"incomplete",
159
159
"rejected",
160
160
"suspended",
161
161
"deleted"
162
162
]
163
163
},
164
164
"handle": {
165
165
"type": "string",
166
166
"format": "handle",
167
167
"description": "The author's handle, present only when it resolves back to did. Absent is normal and not an error: a handle that has just changed, or one whose DNS is unreachable, is reported as absent rather than as a claim, and clients show did instead."
168
168
},
169
169
"params": {
170
170
"type": "array",
171
171
"items": {
172
172
"ref": "space.highport.sites.tile#param",
173
173
"type": "ref"
174
174
}
175
175
},
176
176
"iconUrl": {
177
177
"type": "string",
178
178
"format": "uri",
179
179
"description": "https://highport.space/xrpc/space.highport.sites.getTileIcon?cid={cid}; absent if the tile has no icon."
180
180
},
181
181
"indexedAt": {
182
182
"type": "string",
183
183
"format": "datetime"
184
184
},
185
185
"latestCid": {
186
186
"type": "string",
187
187
"format": "cid",
188
188
"description": "The newest indexed version at this URI, when it differs from cid."
189
189
},
190
190
"entryCount": {
191
191
"type": "integer"
192
192
},
193
193
"totalBytes": {
194
194
"type": "integer"
195
195
},
196
196
"description": {
197
197
"type": "string"
198
198
}
199
199
}
200
200
},
201
201
"spaceView": {
202
202
"type": "object",
203
203
"required": [
204
204
"uri",
205
205
"authority",
206
206
"skey",
207
207
"syncState",
208
208
"connectedAt"
209
209
],
210
210
"properties": {
211
211
"uri": {
212
212
"type": "string",
213
213
"format": "at-uri"
214
214
},
215
215
"skey": {
216
216
"type": "string"
217
217
},
218
218
"policy": {
219
219
"type": "string",
220
220
"knownValues": [
221
221
"public",
222
222
"member-list",
223
223
"managing-app",
224
224
"unknown"
225
225
]
226
226
},
227
227
"headRev": {
228
228
"type": "string"
229
229
},
230
230
"appAccess": {
231
231
"type": "string",
232
232
"knownValues": [
233
233
"open",
234
234
"allow-list",
235
235
"unknown"
236
236
]
237
237
},
238
238
"authority": {
239
239
"type": "string",
240
240
"format": "did"
241
241
},
242
242
"syncState": {
243
243
"ref": "#spaceSyncState",
244
244
"type": "ref"
245
245
},
246
246
"tileCount": {
247
247
"type": "integer"
248
248
},
249
249
"connectedAt": {
250
250
"type": "string",
251
251
"format": "datetime"
252
252
},
253
253
"domainCount": {
254
254
"type": "integer"
255
255
},
256
256
"lastCheckedAt": {
257
257
"type": "string",
258
258
"format": "datetime"
259
259
},
260
260
"lastNotifiedAt": {
261
261
"type": "string",
262
262
"format": "datetime"
263
263
},
264
264
"accessExpiresAt": {
265
265
"type": "string",
266
266
"format": "datetime",
267
267
"description": "When bard's current space credential expires; absent when bard holds none."
268
268
},
269
269
"accessGrantedBy": {
270
270
"type": "string",
271
271
"format": "did"
272
272
},
273
273
"queuedNotifications": {
274
274
"type": "integer",
275
275
"description": "Receipts waiting for a credential."
276
276
},
277
277
"registrationExpiresAt": {
278
278
"type": "string",
279
279
"format": "datetime"
280
280
}
281
281
}
282
282
},
283
283
"tlsStatus": {
284
284
"type": "string",
285
285
"knownValues": [
286
286
"none",
287
287
"pending",
288
288
"issued",
289
289
"renewing",
290
290
"failed"
291
291
]
292
292
},
293
293
"domainView": {
294
294
"type": "object",
295
295
"required": [
296
296
"domain",
297
297
"did",
298
298
"status",
299
299
"createdAt"
300
300
],
301
301
"properties": {
302
302
"did": {
303
303
"type": "string",
304
304
"format": "did"
305
305
},
306
306
"tls": {
307
307
"ref": "#tlsStatus",
308
308
"type": "ref"
309
309
},
310
310
"space": {
311
311
"type": "string",
312
312
"format": "at-uri",
313
313
"description": "The space the domain is registered to; absent for a DID-registered domain. The serving record is the space authority's."
314
314
},
315
315
"domain": {
316
316
"type": "string"
317
317
},
318
318
"status": {
319
319
"ref": "#domainStatus",
320
320
"type": "ref"
321
321
},
322
322
"tileCid": {
323
323
"type": "string",
324
324
"format": "cid"
325
325
},
326
326
"tileUri": {
327
327
"type": "string",
328
328
"format": "at-uri"
329
329
},
330
330
"activeCid": {
331
331
"type": "string",
332
332
"format": "cid"
333
333
},
334
334
"activeRev": {
335
335
"type": "string"
336
336
},
337
337
"activeUri": {
338
338
"type": "string",
339
339
"format": "at-uri"
340
340
},
341
341
"createdAt": {
342
342
"type": "string",
343
343
"format": "datetime"
344
344
},
345
345
"entryCount": {
346
346
"type": "integer"
347
347
},
348
348
"pendingCid": {
349
349
"type": "string",
350
350
"format": "cid",
351
351
"description": "A validated, prepared record awaiting its commit, if any."
352
352
},
353
353
"sourceKind": {
354
354
"type": "string",
355
355
"knownValues": [
356
356
"inline",
357
357
"tile"
358
358
]
359
359
},
360
360
"totalBytes": {
361
361
"type": "integer"
362
362
},
363
363
"verifiedAt": {
364
364
"type": "string",
365
365
"format": "datetime"
366
366
},
367
367
"activatedAt": {
368
368
"type": "string",
369
369
"format": "datetime"
370
370
},
371
371
"pendingState": {
372
372
"type": "string",
373
373
"knownValues": [
374
374
"preparing",
375
375
"pending-publication"
376
376
]
377
377
}
378
378
}
379
379
},
380
380
"indexState": {
381
381
"type": "string",
382
382
"knownValues": [
383
383
"preparing",
384
384
"pending-publication",
385
385
"expired",
386
386
"queued",
387
387
"fetching",
388
388
"materializing",
389
389
"active",
390
390
"superseded",
391
391
"rejected",
392
392
"failed"
393
393
]
394
394
},
395
395
"spaceEvent": {
396
396
"type": "object",
397
397
"required": [
398
398
"seq",
399
399
"space",
400
400
"kind",
401
401
"at"
402
402
],
403
403
"properties": {
404
404
"at": {
405
405
"type": "string",
406
406
"format": "datetime"
407
407
},
408
408
"cid": {
409
409
"type": "string",
410
410
"format": "cid"
411
411
},
412
412
"seq": {
413
413
"type": "integer"
414
414
},
415
415
"kind": {
416
416
"type": "string",
417
417
"knownValues": [
418
418
"record.created",
419
419
"record.updated",
420
420
"record.deleted",
421
421
"site.activated",
422
422
"site.deactivated",
423
423
"tile.ready",
424
424
"tile.incomplete",
425
425
"tile.deleted",
426
426
"access.granted",
427
427
"access.expired",
428
428
"registration.renewed",
429
429
"registration.lapsed",
430
430
"app-not-allowed",
431
431
"space.deleted"
432
432
]
433
433
},
434
434
"actor": {
435
435
"type": "string",
436
436
"format": "did"
437
437
},
438
438
"space": {
439
439
"type": "string",
440
440
"format": "at-uri"
441
441
},
442
442
"subject": {
443
443
"type": "string"
444
444
}
445
445
}
446
446
},
447
447
"blobFailure": {
448
448
"type": "object",
449
449
"required": [
450
450
"cid",
451
451
"role",
452
452
"sourceDid",
453
453
"error"
454
454
],
455
455
"properties": {
456
456
"cid": {
457
457
"type": "string",
458
458
"format": "cid"
459
459
},
460
460
"role": {
461
461
"type": "string",
462
462
"knownValues": [
463
463
"manifest",
464
464
"tile",
465
465
"parameter",
466
466
"notFound"
467
467
]
468
468
},
469
469
"error": {
470
470
"type": "string",
471
471
"description": "BlobUnavailable, CidMismatch, FetchFailed."
472
472
},
473
473
"sourceDid": {
474
474
"type": "string",
475
475
"format": "did"
476
476
}
477
477
}
478
478
},
479
479
"domainEvent": {
480
480
"type": "object",
481
481
"required": [
482
482
"event",
483
483
"createdAt"
484
484
],
485
485
"properties": {
486
486
"actor": {
487
487
"type": "string"
488
488
},
489
489
"event": {
490
490
"type": "string"
491
491
},
492
492
"detail": {
493
493
"type": "unknown"
494
494
},
495
495
"createdAt": {
496
496
"type": "string",
497
497
"format": "datetime"
498
498
}
499
499
}
500
500
},
501
501
"missingBlob": {
502
502
"type": "object",
503
503
"required": [
504
504
"cid",
505
505
"role",
506
506
"sourceDid"
507
507
],
508
508
"properties": {
509
509
"cid": {
510
510
"type": "string",
511
511
"format": "cid"
512
512
},
513
513
"role": {
514
514
"type": "string",
515
515
"knownValues": [
516
516
"manifest",
517
517
"tile",
518
518
"parameter",
519
519
"notFound"
520
520
]
521
521
},
522
522
"sourceDid": {
523
523
"type": "string",
524
524
"format": "did"
525
525
}
526
526
}
527
527
},
528
528
"domainStatus": {
529
529
"type": "string",
530
530
"knownValues": [
531
531
"pending",
532
532
"verifying",
533
533
"verified",
534
534
"active",
535
535
"failed",
536
536
"suspended",
537
537
"released"
538
538
]
539
539
},
540
540
"denylistEntry": {
541
541
"type": "object",
542
542
"required": [
543
543
"subject",
544
544
"kind",
545
545
"createdAt"
546
546
],
547
547
"properties": {
548
548
"kind": {
549
549
"type": "string",
550
550
"knownValues": [
551
551
"domain",
552
552
"did",
553
553
"uri",
554
554
"cid",
555
555
"pattern",
556
556
"space"
557
557
]
558
558
},
559
559
"actor": {
560
560
"type": "string"
561
561
},
562
562
"reason": {
563
563
"type": "string"
564
564
},
565
565
"subject": {
566
566
"type": "string"
567
567
},
568
568
"createdAt": {
569
569
"type": "string",
570
570
"format": "datetime"
571
571
}
572
572
}
573
573
},
574
574
"dnsInstruction": {
575
575
"type": "object",
576
576
"required": [
577
577
"type",
578
578
"name",
579
579
"value"
580
580
],
581
581
"properties": {
582
582
"ttl": {
583
583
"type": "integer"
584
584
},
585
585
"name": {
586
586
"type": "string",
587
587
"description": "Fully-qualified record name."
588
588
},
589
589
"type": {
590
590
"type": "string",
591
591
"knownValues": [
592
592
"TXT",
593
593
"CNAME",
594
594
"ALIAS",
595
595
"ANAME",
596
596
"A",
597
597
"AAAA"
598
598
]
599
599
},
600
600
"value": {
601
601
"type": "string"
602
602
},
603
603
"purpose": {
604
604
"type": "string",
605
605
"knownValues": [
606
606
"ownership",
607
607
"certificate",
608
608
"traffic"
609
609
]
610
610
},
611
611
"required": {
612
612
"type": "boolean"
613
613
}
614
614
}
615
615
},
616
616
"malwareFinding": {
617
617
"type": "object",
618
618
"required": [
619
619
"id",
620
620
"cid",
621
621
"signature",
622
622
"class",
623
623
"source",
624
624
"foundAt"
625
625
],
626
626
"properties": {
627
627
"id": {
628
628
"type": "integer",
629
629
"description": "The finding's row id, which the denylist entry's reason names."
630
630
},
631
631
"cid": {
632
632
"type": "string",
633
633
"description": "The content address. `-` for a detection at upload, where nothing was stored."
634
634
},
635
635
"did": {
636
636
"type": "string",
637
637
"format": "did",
638
638
"description": "The repository the bytes were fetched from — for a tile resource the tile's author, not the site owner. Absent for content bard authored."
639
639
},
640
640
"uri": {
641
641
"type": "string",
642
642
"format": "at-uri",
643
643
"description": "The record that referenced it."
644
644
},
645
645
"path": {
646
646
"type": "string",
647
647
"description": "The manifest key the bytes were mapped at — the field that answers which file. Absent where there is no key: the notFound resource, an upload refused before any record referenced it, and a rescan, which starts from a CID."
648
648
},
649
649
"class": {
650
650
"type": "string",
651
651
"description": "`unwanted` is a PUA match and stops short of the publishing identity under the default policy.",
652
652
"knownValues": [
653
653
"malware",
654
654
"unwanted"
655
655
]
656
656
},
657
657
"domain": {
658
658
"type": "string",
659
659
"description": "The hostname it would have served at."
660
660
},
661
661
"source": {
662
662
"type": "string",
663
663
"description": "Where it was found. `rescan` means the content was clean when it arrived and a signature has caught up with it; `admin` means an operator asked about this CID rather than the sweep reaching it.",
664
664
"knownValues": [
665
665
"fetch",
666
666
"upload",
667
667
"rescan",
668
668
"admin"
669
669
]
670
670
},
671
671
"foundAt": {
672
672
"type": "string",
673
673
"format": "datetime"
674
674
},
675
675
"signature": {
676
676
"type": "string",
677
677
"description": "The signature name, verbatim from the engine."
678
678
},
679
679
"quarantinedAt": {
680
680
"type": "string",
681
681
"format": "datetime",
682
682
"description": "When the response finished. Absent means it has not: the content is denied and may still be served."
683
683
}
684
684
},
685
685
"description": "One malware detection. Written before anything is denied or deleted, because the quarantine destroys the sample and nothing after that can re-derive why."
686
686
},
687
687
"spaceSyncState": {
688
688
"type": "string",
689
689
"knownValues": [
690
690
"connecting",
691
691
"syncing",
692
692
"synced",
693
693
"credential-expired",
694
694
"registration-lapsed",
695
695
"app-not-allowed",
696
696
"authority-unreachable",
697
697
"deleted",
698
698
"disconnected"
699
699
]
700
700
},
701
701
"edgeReachStatus": {
702
702
"type": "string",
703
-
"description": "Whether bard's edge routes a serving hostname to bard. unknown means no probe has been made and must never be read as a fault; routed means the probe reached bard-origin; foreign means something else answered for the hostname; unreachable means nothing answered at all.",
703
+
"description": "Whether bard's edge routes a serving hostname to this deployment. unknown means no probe has been made and must never be read as a fault; routed means the probe reached this deployment's bard-origin; foreign means something else answered for the hostname; unreachable means nothing answered at all; other-deployment means a bard origin belonging to a different deployment answered; unproven means the answer looked like this deployment's but could not answer the reachability challenge, so something may be imitating it.",
704
704
"knownValues": [
705
705
"unknown",
706
706
"routed",
707
707
"foreign",
708
-
"unreachable"
708
+
"unreachable",
709
+
"other-deployment",
710
+
"unproven"
709
711
]
710
712
},
711
713
"validationError": {
712
714
"type": "object",
713
715
"required": [
714
716
"name",
715
717
"message"
716
718
],
717
719
"properties": {
718
720
"name": {
719
721
"type": "string",
720
722
"description": "A DESIGN.md §3.8 error name, e.g. DuplicatePath, RedirectTargetNotFound, ParameterTypeMismatch."
721
723
},
722
724
"path": {
723
725
"type": "string",
724
726
"description": "JSON Pointer into the record, when the error concerns one field or entry."
725
727
},
726
728
"message": {
727
729
"type": "string"
728
730
}
729
731
}
730
732
},
731
733
"edgeReachability": {
732
734
"type": "object",
733
735
"required": [
734
736
"status",
735
737
"domain"
736
738
],
737
739
"properties": {
738
740
"detail": {
739
741
"type": "string",
740
742
"description": "What answered, for a person: a status line, or a transport error. Diagnostic only; nothing branches on it."
741
743
},
742
744
"domain": {
743
745
"type": "string",
744
746
"maxLength": 253,
745
747
"description": "The hostname that was probed, so a reader is told which name is not arriving."
746
748
},
747
749
"status": {
748
750
"ref": "#edgeReachStatus",
749
751
"type": "ref"
750
752
},
751
753
"checkedAt": {
752
754
"type": "string",
753
755
"format": "datetime",
754
756
"description": "When the probe was made. Absent when status is unknown."
755
757
}
756
758
},
757
759
"description": "What the deployment's own edge answered for a hostname, measured over the network rather than read from edge configuration. A site can be indexed and activated while the edge has nowhere to send its hostname, and this is the only field that says so."
758
760
},
759
761
"verificationView": {
760
762
"type": "object",
761
763
"required": [
762
764
"status",
763
765
"checks"
764
766
],
765
767
"properties": {
766
768
"checks": {
767
769
"type": "array",
768
770
"items": {
769
771
"ref": "#verificationCheck",
770
772
"type": "ref"
771
773
}
772
774
},
773
775
"status": {
774
776
"ref": "#domainStatus",
775
777
"type": "ref"
776
778
},
777
779
"lastCheckedAt": {
778
780
"type": "string",
779
781
"format": "datetime"
780
782
}
781
783
}
782
784
},
783
785
"preparationStatus": {
784
786
"type": "object",
785
787
"required": [
786
788
"state",
787
789
"cid",
788
790
"fetched",
789
791
"pending",
790
792
"failed"
791
793
],
792
794
"properties": {
793
795
"cid": {
794
796
"type": "string",
795
797
"format": "cid"
796
798
},
797
799
"state": {
798
800
"type": "string",
799
801
"knownValues": [
800
802
"preparing",
801
803
"pending-publication",
802
804
"expired"
803
805
]
804
806
},
805
807
"failed": {
806
808
"type": "array",
807
809
"items": {
808
810
"ref": "#blobFailure",
809
811
"type": "ref"
810
812
}
811
813
},
812
814
"fetched": {
813
815
"type": "integer"
814
816
},
815
817
"pending": {
816
818
"type": "integer"
817
819
},
818
820
"expiresAt": {
819
821
"type": "string",
820
822
"format": "datetime"
821
823
}
822
824
}
823
825
},
824
826
"verificationCheck": {
825
827
"type": "object",
826
828
"required": [
827
829
"name",
828
830
"passed",
829
831
"checkedAt"
830
832
],
831
833
"properties": {
832
834
"name": {
833
835
"type": "string",
834
836
"knownValues": [
835
837
"ownership",
836
838
"traffic",
837
839
"conflict"
838
840
]
839
841
},
840
842
"detail": {
841
843
"type": "string"
842
844
},
843
845
"passed": {
844
846
"type": "boolean"
845
847
},
846
848
"checkedAt": {
847
849
"type": "string",
848
850
"format": "datetime"
849
851
}
850
852
}
851
853
}
852
854
},
853
855
"$type": "com.atproto.lexicon.schema",
854
856
"lexicon": 1
855
857
}