space.highport.defs

lexicons.highport.space

Schema Diff

+73 -35

From

CID
bafyreigzwpq2ewe...
Indexed At
2026-09-15 17:46 UTC
View this version

To

CID
bafyreie2t2jgjgm...
Indexed At
2026-09-18 15:13 UTC
View this version

Compatibility Analysis

Breaking Changes Detected

2 breaking changes, 12 non-breaking changes.

Breaking Changes (2)
  • RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "space.highport.defs#defaultTileView", src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.uri", kind: "prop", name: Some("uri") }
  • RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "space.highport.defs#defaultTileView", src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.cid", kind: "prop", name: Some("cid") }
Non-Breaking Changes (12)
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView.appliedTo" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView.cid" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView.name" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView.setAt" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#defaultTileView.uri" }
  • AddedVertex AddedVertex { vertex_id: "space.highport.defs#delegationView.defaultTile" }
  • AddedEdge AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.appliedTo", kind: "prop", name: Some("appliedTo") }
  • AddedEdge AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.name", kind: "prop", name: Some("name") }
  • AddedEdge AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.setAt", kind: "prop", name: Some("setAt") }
  • AddedEdge AddedEdge { src: "space.highport.defs#delegationView", tgt: "space.highport.defs#delegationView.defaultTile", kind: "prop", name: Some("defaultTile") }
  • AddedEdge AddedEdge { src: "space.highport.defs#delegationView.defaultTile", tgt: "space.highport.defs#defaultTileView", kind: "ref", name: None }

Migration Guidance

Added Elements

  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView" }
  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView.appliedTo" }
  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView.cid" }
  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView.name" }
  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView.setAt" }
  • AddedVertex { vertex_id: "space.highport.defs#defaultTileView.uri" }
  • AddedVertex { vertex_id: "space.highport.defs#delegationView.defaultTile" }

Additional Notes

  • Breaking: RequiredEdgeAdded { vertex_id: "space.highport.defs#defaultTileView", src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.uri", kind: "prop", name: Some("uri") }
  • Breaking: RequiredEdgeAdded { vertex_id: "space.highport.defs#defaultTileView", src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.cid", kind: "prop", name: Some("cid") }
  • Non-breaking: AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.appliedTo", kind: "prop", name: Some("appliedTo") }
  • Non-breaking: AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.name", kind: "prop", name: Some("name") }
  • Non-breaking: AddedEdge { src: "space.highport.defs#defaultTileView", tgt: "space.highport.defs#defaultTileView.setAt", kind: "prop", name: Some("setAt") }
  • Non-breaking: AddedEdge { src: "space.highport.defs#delegationView", tgt: "space.highport.defs#delegationView.defaultTile", kind: "prop", name: Some("defaultTile") }
  • Non-breaking: AddedEdge { src: "space.highport.defs#delegationView.defaultTile", tgt: "space.highport.defs#defaultTileView", kind: "ref", name: None }
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 -
          "description": "Present for a site published from a space; attribution survives the plane."
104 +
          "description": "Present for a site published from a space."
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 -
          "description": "Present for a space tile; never on the public surface."
151 +
          "description": "Present for a space tile. Never shown 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 -
          "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."
167 +
          "description": "The author's handle, present only if it resolves back to did. Often absent, for example right after a handle change or when DNS is unreachable. 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 -
          "description": "When bard's current space credential expires; absent when bard holds none."
267 +
          "description": "When bard's current credential for the space expires. Absent if 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 -
          "description": "Receipts waiting for a credential."
275 +
          "description": "Notification 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 -
          "description": "The space the domain is registered to; absent for a DID-registered domain. The serving record is the space authority's."
313 +
          "description": "The space the domain is registered to. Absent for a domain registered to a DID. The record served 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
        "delegation": {
346 346
          "ref": "#delegationView",
347 347
          "type": "ref",
348 -
          "description": "On a base: what its owner has enabled and granted. Absent on a domain that is not a base."
348 +
          "description": "For a base: what its owner has enabled and granted. Absent on any other domain."
349 349
        },
350 350
        "entryCount": {
351 351
          "type": "integer"
352 352
        },
353 353
        "pendingCid": {
354 354
          "type": "string",
355 355
          "format": "cid",
356 -
          "description": "A validated, prepared record awaiting its commit, if any."
356 +
          "description": "A validated record waiting to be committed, if there is one."
357 357
        },
358 358
        "sourceKind": {
359 359
          "type": "string",
360 360
          "knownValues": [
361 361
            "inline",
362 362
            "tile"
363 363
          ]
364 364
        },
365 365
        "totalBytes": {
366 366
          "type": "integer"
367 367
        },
368 368
        "verifiedAt": {
369 369
          "type": "string",
370 370
          "format": "datetime"
371 371
        },
372 372
        "activatedAt": {
373 373
          "type": "string",
374 374
          "format": "datetime"
375 375
        },
376 376
        "pendingState": {
377 377
          "type": "string",
378 378
          "knownValues": [
379 379
            "preparing",
380 380
            "pending-publication"
381 381
          ]
382 382
        },
383 383
        "delegatedBase": {
384 384
          "type": "string",
385 -
          "description": "On a name reserved under a delegation base: the base whose owner granted it. did is then the identity the name was reserved for, not the base's owner."
385 +
          "description": "For a name reserved under a delegation base: that base. In this case did is the identity the name was reserved for, not the base's owner."
386 386
        }
387 387
      }
388 388
    },
389 389
    "indexState": {
390 390
      "type": "string",
391 391
      "knownValues": [
392 392
        "preparing",
393 393
        "pending-publication",
394 394
        "expired",
395 395
        "queued",
396 396
        "fetching",
397 397
        "materializing",
398 398
        "active",
399 399
        "superseded",
400 400
        "rejected",
401 401
        "failed"
402 402
      ]
403 403
    },
404 404
    "spaceEvent": {
405 405
      "type": "object",
406 406
      "required": [
407 407
        "seq",
408 408
        "space",
409 409
        "kind",
410 410
        "at"
411 411
      ],
412 412
      "properties": {
413 413
        "at": {
414 414
          "type": "string",
415 415
          "format": "datetime"
416 416
        },
417 417
        "cid": {
418 418
          "type": "string",
419 419
          "format": "cid"
420 420
        },
421 421
        "seq": {
422 422
          "type": "integer"
423 423
        },
424 424
        "kind": {
425 425
          "type": "string",
426 426
          "knownValues": [
427 427
            "record.created",
428 428
            "record.updated",
429 429
            "record.deleted",
430 430
            "site.activated",
431 431
            "site.deactivated",
432 432
            "tile.ready",
433 433
            "tile.incomplete",
434 434
            "tile.deleted",
435 435
            "access.granted",
436 436
            "access.expired",
437 437
            "registration.renewed",
438 438
            "registration.lapsed",
439 439
            "app-not-allowed",
440 440
            "space.deleted"
441 441
          ]
442 442
        },
443 443
        "actor": {
444 444
          "type": "string",
445 445
          "format": "did"
446 446
        },
447 447
        "space": {
448 448
          "type": "string",
449 449
          "format": "at-uri"
450 450
        },
451 451
        "subject": {
452 452
          "type": "string"
453 453
        }
454 454
      }
455 455
    },
456 456
    "blobFailure": {
457 457
      "type": "object",
458 458
      "required": [
459 459
        "cid",
460 460
        "role",
461 461
        "sourceDid",
462 462
        "error"
463 463
      ],
464 464
      "properties": {
465 465
        "cid": {
466 466
          "type": "string",
467 467
          "format": "cid"
468 468
        },
469 469
        "role": {
470 470
          "type": "string",
471 471
          "knownValues": [
472 472
            "manifest",
473 473
            "tile",
474 474
            "parameter",
475 475
            "notFound"
476 476
          ]
477 477
        },
478 478
        "error": {
479 479
          "type": "string",
480 -
          "description": "BlobUnavailable, CidMismatch, FetchFailed."
480 +
          "description": "One of BlobUnavailable, CidMismatch or FetchFailed."
481 481
        },
482 482
        "sourceDid": {
483 483
          "type": "string",
484 484
          "format": "did"
485 485
        }
486 486
      }
487 487
    },
488 488
    "domainEvent": {
489 489
      "type": "object",
490 490
      "required": [
491 491
        "event",
492 492
        "createdAt"
493 493
      ],
494 494
      "properties": {
495 495
        "actor": {
496 496
          "type": "string"
497 497
        },
498 498
        "event": {
499 499
          "type": "string"
500 500
        },
501 501
        "detail": {
502 502
          "type": "unknown"
503 503
        },
504 504
        "createdAt": {
505 505
          "type": "string",
506 506
          "format": "datetime"
507 507
        }
508 508
      }
509 509
    },
510 510
    "missingBlob": {
511 511
      "type": "object",
512 512
      "required": [
513 513
        "cid",
514 514
        "role",
515 515
        "sourceDid"
516 516
      ],
517 517
      "properties": {
518 518
        "cid": {
519 519
          "type": "string",
520 520
          "format": "cid"
521 521
        },
522 522
        "role": {
523 523
          "type": "string",
524 524
          "knownValues": [
525 525
            "manifest",
526 526
            "tile",
527 527
            "parameter",
528 528
            "notFound"
529 529
          ]
530 530
        },
531 531
        "sourceDid": {
532 532
          "type": "string",
533 533
          "format": "did"
534 534
        }
535 535
      }
536 536
    },
537 537
    "domainStatus": {
538 538
      "type": "string",
539 539
      "knownValues": [
540 540
        "pending",
541 541
        "verifying",
542 542
        "verified",
543 543
        "active",
544 544
        "failed",
545 545
        "suspended",
546 546
        "released"
547 547
      ]
548 548
    },
549 549
    "denylistEntry": {
550 550
      "type": "object",
551 551
      "required": [
552 552
        "subject",
553 553
        "kind",
554 554
        "createdAt"
555 555
      ],
556 556
      "properties": {
557 557
        "kind": {
558 558
          "type": "string",
559 559
          "knownValues": [
560 560
            "domain",
561 561
            "did",
562 562
            "uri",
563 563
            "cid",
564 564
            "pattern",
565 565
            "space"
566 566
          ]
567 567
        },
568 568
        "actor": {
569 569
          "type": "string"
570 570
        },
571 571
        "reason": {
572 572
          "type": "string"
573 573
        },
574 574
        "subject": {
575 575
          "type": "string"
576 576
        },
577 577
        "createdAt": {
578 578
          "type": "string",
579 579
          "format": "datetime"
580 580
        }
581 581
      }
582 582
    },
583 583
    "delegationView": {
584 584
      "type": "object",
585 585
      "required": [
586 586
        "certMode"
587 587
      ],
588 588
      "properties": {
589 589
        "state": {
590 590
          "ref": "#delegationState",
591 591
          "type": "ref",
592 -
          "description": "Absent on a base that has not enabled delegation."
592 +
          "description": "Absent if the base has not enabled delegation."
593 593
        },
594 594
        "certMode": {
595 595
          "type": "string",
596 -
          "description": "How names under the base obtain certificates. Every base starts per-name.",
596 +
          "description": "How names under the base get certificates. Every base starts as per-name.",
597 597
          "knownValues": [
598 598
            "per-name",
599 599
            "wildcard"
600 600
          ]
601 601
        },
602 602
        "maxNames": {
603 603
          "type": "integer",
604 -
          "description": "The most names the base may hold in reservation."
604 +
          "description": "The most names the base can reserve."
605 605
        },
606 606
        "grantedAt": {
607 607
          "type": "string",
608 608
          "format": "datetime",
609 609
          "description": "When the live wildcard grant was made."
610 610
        },
611 +
        "defaultTile": {
612 +
          "ref": "#defaultTileView",
613 +
          "type": "ref",
614 +
          "description": "The tile served on names under this base whose subject has not published a site. Absent when the base has set none."
615 +
        },
611 616
        "probeHostname": {
612 617
          "type": "string",
613 618
          "maxLength": 253,
614 -
          "description": "The random name under the base through which the wildcard is proven to route."
619 +
          "description": "A random name under the base, used to prove the wildcard routes."
615 620
        },
616 621
        "challengeTarget": {
617 622
          "type": "string",
618 -
          "description": "The name the base's _acme-challenge CNAME must point at, exactly as the certificate issuer writes to it. Present only while a wildcard grant is live."
623 +
          "description": "Where the base's _acme-challenge CNAME must point, exactly as the certificate issuer writes it. Present only while a wildcard grant is live."
619 624
        },
620 625
        "wildcardObservedAt": {
621 626
          "type": "string",
622 627
          "format": "datetime",
623 -
          "description": "When the base's wildcard certificate was first seen in certificate storage."
628 +
          "description": "When the base's wildcard certificate first appeared in certificate storage."
624 629
        }
625 630
      },
626 -
      "description": "What a base's owner has enabled and granted. Each field but certMode is absent where the base has no such fact."
631 +
      "description": "What a base's owner has enabled and granted. Fields other than certMode are absent when they do not apply."
627 632
    },
628 633
    "dnsInstruction": {
629 634
      "type": "object",
630 635
      "required": [
631 636
        "type",
632 637
        "name",
633 638
        "value"
634 639
      ],
635 640
      "properties": {
636 641
        "ttl": {
637 642
          "type": "integer"
638 643
        },
639 644
        "name": {
640 645
          "type": "string",
641 646
          "description": "Fully-qualified record name."
642 647
        },
643 648
        "type": {
644 649
          "type": "string",
645 650
          "knownValues": [
646 651
            "TXT",
647 652
            "CNAME",
648 653
            "ALIAS",
649 654
            "ANAME",
650 655
            "A",
651 656
            "AAAA"
652 657
          ]
653 658
        },
654 659
        "value": {
655 660
          "type": "string"
656 661
        },
657 662
        "purpose": {
658 663
          "type": "string",
659 664
          "knownValues": [
660 665
            "ownership",
661 666
            "certificate",
662 667
            "traffic"
663 668
          ]
664 669
        },
665 670
        "required": {
666 671
          "type": "boolean"
667 672
        }
668 673
      }
669 674
    },
670 675
    "malwareFinding": {
671 676
      "type": "object",
672 677
      "required": [
673 678
        "id",
674 679
        "cid",
675 680
        "signature",
676 681
        "class",
677 682
        "source",
678 683
        "foundAt"
679 684
      ],
680 685
      "properties": {
681 686
        "id": {
682 687
          "type": "integer",
683 -
          "description": "The finding's row id, which the denylist entry's reason names."
688 +
          "description": "The finding's ID. The matching denylist entry's reason refers to it."
684 689
        },
685 690
        "cid": {
686 691
          "type": "string",
687 -
          "description": "The content address. `-` for a detection at upload, where nothing was stored."
692 +
          "description": "The content address, or `-` for a detection at upload, when nothing was stored."
688 693
        },
689 694
        "did": {
690 695
          "type": "string",
691 696
          "format": "did",
692 -
          "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."
697 +
          "description": "The repository the bytes came from. For a tile resource, that is the tile's author, not the site owner. Absent for content bard authored."
693 698
        },
694 699
        "uri": {
695 700
          "type": "string",
696 701
          "format": "at-uri",
697 -
          "description": "The record that referenced it."
702 +
          "description": "The record that referenced the content."
698 703
        },
699 704
        "path": {
700 705
          "type": "string",
701 -
          "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."
706 +
          "description": "The manifest path the bytes were mapped to, which identifies the file. Absent when there is no path: the notFound resource, an upload refused before any record referenced it, or a rescan."
702 707
        },
703 708
        "class": {
704 709
          "type": "string",
705 -
          "description": "`unwanted` is a PUA match and stops short of the publishing identity under the default policy.",
710 +
          "description": "`unwanted` is a PUA match. Under the default policy, the response stops short of the publishing identity.",
706 711
          "knownValues": [
707 712
            "malware",
708 713
            "unwanted"
709 714
          ]
710 715
        },
711 716
        "domain": {
712 717
          "type": "string",
713 -
          "description": "The hostname it would have served at."
718 +
          "description": "The hostname the content would have been served at."
714 719
        },
715 720
        "source": {
716 721
          "type": "string",
717 -
          "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.",
722 +
          "description": "Where the detection happened. `rescan`: the content was clean on arrival and a newer signature caught it. `admin`: an operator asked for this CID to be scanned.",
718 723
          "knownValues": [
719 724
            "fetch",
720 725
            "upload",
721 726
            "rescan",
722 727
            "admin"
723 728
          ]
724 729
        },
725 730
        "foundAt": {
726 731
          "type": "string",
727 732
          "format": "datetime"
728 733
        },
729 734
        "signature": {
730 735
          "type": "string",
731 -
          "description": "The signature name, verbatim from the engine."
736 +
          "description": "The signature name, exactly as the scanner reported it."
732 737
        },
733 738
        "quarantinedAt": {
734 739
          "type": "string",
735 740
          "format": "datetime",
736 -
          "description": "When the response finished. Absent means it has not: the content is denied and may still be served."
741 +
          "description": "When the response finished. Absent while it is still underway: the content is denied but may still be served."
737 742
        }
738 743
      },
739 -
      "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."
744 +
      "description": "One malware detection. It is recorded before anything is denied or deleted, because quarantine destroys the sample."
740 745
    },
741 746
    "spaceSyncState": {
742 747
      "type": "string",
743 748
      "knownValues": [
744 749
        "connecting",
745 750
        "syncing",
746 751
        "synced",
747 752
        "credential-expired",
748 753
        "registration-lapsed",
749 754
        "app-not-allowed",
750 755
        "authority-unreachable",
751 756
        "deleted",
752 757
        "disconnected"
753 758
      ]
754 759
    },
760 +
    "defaultTileView": {
761 +
      "type": "object",
762 +
      "required": [
763 +
        "uri",
764 +
        "cid"
765 +
      ],
766 +
      "properties": {
767 +
        "cid": {
768 +
          "type": "string",
769 +
          "format": "cid",
770 +
          "description": "The pinned version."
771 +
        },
772 +
        "uri": {
773 +
          "type": "string",
774 +
          "format": "at-uri",
775 +
          "description": "The tile record's AT-URI."
776 +
        },
777 +
        "name": {
778 +
          "type": "string",
779 +
          "description": "The tile's declared name, as it was when this was read."
780 +
        },
781 +
        "setAt": {
782 +
          "type": "string",
783 +
          "format": "datetime",
784 +
          "description": "When the base owner bound it."
785 +
        },
786 +
        "appliedTo": {
787 +
          "type": "integer",
788 +
          "description": "How many names under the base are serving it now. Names whose subject has published their own site are not counted."
789 +
        }
790 +
      },
791 +
      "description": "A base's default tile: what unclaimed names under it serve. The binding pins a CID, so a later version of the tile does not change what they serve."
792 +
    },
755 793
    "delegationState": {
756 794
      "type": "string",
757 -
      "description": "Where a base's delegation stands. probing means the wildcard has not yet been proven to route; enabled means it has; routing-lapsed means a proven wildcard stopped routing past its grace, and the names under the base are suspended until it routes again.",
795 +
      "description": "Where a base's delegation stands. probing: the wildcard has not been shown to route yet. enabled: it has. routing-lapsed: the wildcard stopped routing for longer than the grace period, and names under the base are suspended until it routes again.",
758 796
      "knownValues": [
759 797
        "probing",
760 798
        "enabled",
761 799
        "routing-lapsed"
762 800
      ]
763 801
    },
764 802
    "edgeReachStatus": {
765 803
      "type": "string",
766 -
      "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.",
804 +
      "description": "Whether bard's edge routes a serving hostname to this deployment. unknown: not probed yet, which is not a fault. routed: the probe reached this deployment's bard-origin. foreign: something else answered. unreachable: nothing answered. other-deployment: a different bard deployment answered. unproven: the answer looked like this deployment's but failed the reachability challenge, so something may be imitating it.",
767 805
      "knownValues": [
768 806
        "unknown",
769 807
        "routed",
770 808
        "foreign",
771 809
        "unreachable",
772 810
        "other-deployment",
773 811
        "unproven"
774 812
      ]
775 813
    },
776 814
    "validationError": {
777 815
      "type": "object",
778 816
      "required": [
779 817
        "name",
780 818
        "message"
781 819
      ],
782 820
      "properties": {
783 821
        "name": {
784 822
          "type": "string",
785 -
          "description": "A DESIGN.md ยง3.8 error name, e.g. DuplicatePath, RedirectTargetNotFound, ParameterTypeMismatch."
823 +
          "description": "A validation error name, such as DuplicatePath, RedirectTargetNotFound or ParameterTypeMismatch."
786 824
        },
787 825
        "path": {
788 826
          "type": "string",
789 -
          "description": "JSON Pointer into the record, when the error concerns one field or entry."
827 +
          "description": "JSON Pointer to the field or entry the error is about, if there is one."
790 828
        },
791 829
        "message": {
792 830
          "type": "string"
793 831
        }
794 832
      }
795 833
    },
796 834
    "edgeReachability": {
797 835
      "type": "object",
798 836
      "required": [
799 837
        "status",
800 838
        "domain"
801 839
      ],
802 840
      "properties": {
803 841
        "detail": {
804 842
          "type": "string",
805 -
          "description": "What answered, for a person: a status line, or a transport error. Diagnostic only; nothing branches on it."
843 +
          "description": "What answered, as a status line or a transport error. Meant for people; do not branch on it."
806 844
        },
807 845
        "domain": {
808 846
          "type": "string",
809 847
          "maxLength": 253,
810 -
          "description": "The hostname that was probed, so a reader is told which name is not arriving."
848 +
          "description": "The hostname that was probed."
811 849
        },
812 850
        "status": {
813 851
          "ref": "#edgeReachStatus",
814 852
          "type": "ref"
815 853
        },
816 854
        "checkedAt": {
817 855
          "type": "string",
818 856
          "format": "datetime",
819 857
          "description": "When the probe was made. Absent when status is unknown."
820 858
        }
821 859
      },
822 -
      "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."
860 +
      "description": "What this deployment's edge answered for a hostname, probed over the network. A site can be indexed and active while the edge has nowhere to send it, and only this field shows that."
823 861
    },
824 862
    "verificationView": {
825 863
      "type": "object",
826 864
      "required": [
827 865
        "status",
828 866
        "checks"
829 867
      ],
830 868
      "properties": {
831 869
        "checks": {
832 870
          "type": "array",
833 871
          "items": {
834 872
            "ref": "#verificationCheck",
835 873
            "type": "ref"
836 874
          }
837 875
        },
838 876
        "status": {
839 877
          "ref": "#domainStatus",
840 878
          "type": "ref"
841 879
        },
842 880
        "lastCheckedAt": {
843 881
          "type": "string",
844 882
          "format": "datetime"
845 883
        }
846 884
      }
847 885
    },
848 886
    "preparationStatus": {
849 887
      "type": "object",
850 888
      "required": [
851 889
        "state",
852 890
        "cid",
853 891
        "fetched",
854 892
        "pending",
855 893
        "failed"
856 894
      ],
857 895
      "properties": {
858 896
        "cid": {
859 897
          "type": "string",
860 898
          "format": "cid"
861 899
        },
862 900
        "state": {
863 901
          "type": "string",
864 902
          "knownValues": [
865 903
            "preparing",
866 904
            "pending-publication",
867 905
            "expired"
868 906
          ]
869 907
        },
870 908
        "failed": {
871 909
          "type": "array",
872 910
          "items": {
873 911
            "ref": "#blobFailure",
874 912
            "type": "ref"
875 913
          }
876 914
        },
877 915
        "fetched": {
878 916
          "type": "integer"
879 917
        },
880 918
        "pending": {
881 919
          "type": "integer"
882 920
        },
883 921
        "expiresAt": {
884 922
          "type": "string",
885 923
          "format": "datetime"
886 924
        }
887 925
      }
888 926
    },
889 927
    "verificationCheck": {
890 928
      "type": "object",
891 929
      "required": [
892 930
        "name",
893 931
        "passed",
894 932
        "checkedAt"
895 933
      ],
896 934
      "properties": {
897 935
        "name": {
898 936
          "type": "string",
899 937
          "knownValues": [
900 938
            "ownership",
901 939
            "traffic",
902 940
            "conflict",
903 941
            "certificate"
904 942
          ]
905 943
        },
906 944
        "detail": {
907 945
          "type": "string"
908 946
        },
909 947
        "passed": {
910 948
          "type": "boolean"
911 949
        },
912 950
        "checkedAt": {
913 951
          "type": "string",
914 952
          "format": "datetime"
915 953
        }
916 954
      }
917 955
    }
918 956
  },
919 957
  "$type": "com.atproto.lexicon.schema",
920 958
  "lexicon": 1
921 959
}

Compare Other Versions

Lexicon Garden

@