space.highport.manage.getIndexStatus
Schema Diff
+13 -8
Compatibility Analysis
Backward Compatible
Backward compatible. 4 non-breaking changes.
Non-Breaking Changes (4)
- AddedVertex AddedVertex { vertex_id: "space.highport.defs#edgeReachability" }
- AddedVertex AddedVertex { vertex_id: "space.highport.manage.getIndexStatus:output.edge" }
- AddedEdge AddedEdge { src: "space.highport.manage.getIndexStatus:output", tgt: "space.highport.manage.getIndexStatus:output.edge", kind: "prop", name: Some("edge") }
- AddedEdge AddedEdge { src: "space.highport.manage.getIndexStatus:output.edge", tgt: "space.highport.defs#edgeReachability", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "space.highport.defs#edgeReachability" }AddedVertex { vertex_id: "space.highport.manage.getIndexStatus:output.edge" }
Additional Notes
- Non-breaking: AddedEdge { src: "space.highport.manage.getIndexStatus:output", tgt: "space.highport.manage.getIndexStatus:output.edge", kind: "prop", name: Some("edge") }
- Non-breaking: AddedEdge { src: "space.highport.manage.getIndexStatus:output.edge", tgt: "space.highport.defs#edgeReachability", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Per-blob visibility into a publish in flight. Exactly one of uri and domain is given. When a domain serves one revision while a later record is prepared, the active revision is the top level and the preparation is reported in preparation; a prepared record with no active revision is reported at the top level.",
5
+
"description": "Per-blob progress of a publish. Give exactly one of uri or domain. The top level describes the active revision, or the prepared record if nothing is active yet. A newer record prepared while another is active appears under preparation.",
6
6
"errors": [
7
7
{
8
-
"description": "Bard knows no record at that URI or domain.",
8
+
"description": "Bard has no record at that URI or domain.",
9
9
"name": "RecordNotFound"
10
10
},
11
11
{
12
-
"description": "The record is not the caller's; for a tile URI the caller must be the tile's repo.",
12
+
"description": "The record does not belong to the caller. For a tile URI, the caller must be the tile's repo.",
13
13
"name": "NotOwner"
14
14
},
15
15
{
16
-
"description": "The URI is in the space form and names a space bard does not serve, or one the caller cannot be placed in. One answer for both, so membership is not an oracle.",
16
+
"description": "The URI is in space form and names a space bard does not serve, or one the caller is not in. Both cases get the same error, so it cannot be used to probe membership.",
17
17
"name": "SpaceNotFound"
18
18
}
19
19
],
20
20
"output": {
21
21
"encoding": "application/json",
22
22
"schema": {
23
23
"properties": {
24
24
"activatedAt": {
25
25
"format": "datetime",
26
26
"type": "string"
27
27
},
28
28
"cid": {
29
29
"format": "cid",
30
30
"type": "string"
31
31
},
32
+
"edge": {
33
+
"description": "Whether the edge routes this site's hostname to bard. Present only for a domain-backed record. An active index state says nothing about routing: a fully indexed site can still have its requests answered by something else. Treat unknown as no opinion.",
34
+
"ref": "space.highport.defs#edgeReachability",
35
+
"type": "ref"
36
+
},
32
37
"entryCount": {
33
38
"type": "integer"
34
39
},
35
40
"errors": {
36
41
"items": {
37
42
"ref": "space.highport.defs#validationError",
38
43
"type": "ref"
39
44
},
40
45
"type": "array"
41
46
},
42
47
"failed": {
43
-
"description": "Blobs that could not be fetched; each carries sourceDid and role, so a BlobUnavailable on a tile blob says plainly that re-uploading will not fix it.",
48
+
"description": "Blobs that could not be fetched. Each includes sourceDid and role, which makes it clear when re-uploading will not help, such as a BlobUnavailable on a tile blob.",
44
49
"items": {
45
50
"ref": "space.highport.defs#blobFailure",
46
51
"type": "ref"
47
52
},
48
53
"type": "array"
49
54
},
50
55
"fetched": {
51
-
"description": "Blobs fetched and CID-verified so far.",
56
+
"description": "Blobs fetched and checked against their CIDs so far.",
52
57
"type": "integer"
53
58
},
54
59
"pending": {
55
60
"description": "Blobs still to fetch.",
56
61
"type": "integer"
57
62
},
58
63
"preparation": {
59
-
"description": "A validated, prepared record awaiting its commit, when the domain is already serving an earlier revision.",
64
+
"description": "A validated record waiting to be committed, while the domain still serves an earlier revision.",
60
65
"ref": "space.highport.defs#preparationStatus",
61
66
"type": "ref"
62
67
},
63
68
"rev": {
64
69
"description": "The commit revision of the indexed record.",
65
70
"type": "string"
66
71
},
67
72
"state": {
68
73
"ref": "space.highport.defs#indexState",
69
74
"type": "ref"
70
75
}
71
76
},
72
77
"required": [
73
78
"state",
74
79
"failed",
75
80
"errors"
76
81
],
77
82
"type": "object"
78
83
}
79
84
},
80
85
"parameters": {
81
86
"properties": {
82
87
"domain": {
83
88
"description": "The site's hostname. Mutually exclusive with uri.",
84
89
"maxLength": 253,
85
90
"type": "string"
86
91
},
87
92
"uri": {
88
-
"description": "The record's AT-URI, public or space form. Mutually exclusive with domain.",
93
+
"description": "The record's AT-URI, in public or space form. Mutually exclusive with domain.",
89
94
"format": "at-uri",
90
95
"type": "string"
91
96
}
92
97
},
93
98
"type": "params"
94
99
},
95
100
"type": "query"
96
101
}
97
102
},
98
103
"id": "space.highport.manage.getIndexStatus",
99
104
"lexicon": 1
100
105
}