space.highport.manage.getIndexStatus
Schema Diff
+5 -0
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
"id": "space.highport.manage.getIndexStatus",
3
3
"defs": {
4
4
"main": {
5
5
"type": "query",
6
6
"errors": [
7
7
{
8
8
"name": "RecordNotFound",
9
9
"description": "Bard knows no record at that URI or domain."
10
10
},
11
11
{
12
12
"name": "NotOwner",
13
13
"description": "The record is not the caller's; for a tile URI the caller must be the tile's repo."
14
14
},
15
15
{
16
16
"name": "SpaceNotFound",
17
17
"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."
18
18
}
19
19
],
20
20
"output": {
21
21
"schema": {
22
22
"type": "object",
23
23
"required": [
24
24
"state",
25
25
"failed",
26
26
"errors"
27
27
],
28
28
"properties": {
29
29
"cid": {
30
30
"type": "string",
31
31
"format": "cid"
32
32
},
33
33
"rev": {
34
34
"type": "string",
35
35
"description": "The commit revision of the indexed record."
36
36
},
37
+
"edge": {
38
+
"ref": "space.highport.defs#edgeReachability",
39
+
"type": "ref",
40
+
"description": "Whether the edge routes this site's hostname to bard. Present only for a domain-backed record. A state of active says the index is complete and says nothing about routing: the two are decided in different places, so a site can be fully indexed while every request to it is answered by something that is not bard. Clients must treat a status of unknown as no opinion."
41
+
},
37
42
"state": {
38
43
"ref": "space.highport.defs#indexState",
39
44
"type": "ref"
40
45
},
41
46
"errors": {
42
47
"type": "array",
43
48
"items": {
44
49
"ref": "space.highport.defs#validationError",
45
50
"type": "ref"
46
51
}
47
52
},
48
53
"failed": {
49
54
"type": "array",
50
55
"items": {
51
56
"ref": "space.highport.defs#blobFailure",
52
57
"type": "ref"
53
58
},
54
59
"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."
55
60
},
56
61
"fetched": {
57
62
"type": "integer",
58
63
"description": "Blobs fetched and CID-verified so far."
59
64
},
60
65
"pending": {
61
66
"type": "integer",
62
67
"description": "Blobs still to fetch."
63
68
},
64
69
"entryCount": {
65
70
"type": "integer"
66
71
},
67
72
"activatedAt": {
68
73
"type": "string",
69
74
"format": "datetime"
70
75
},
71
76
"preparation": {
72
77
"ref": "space.highport.defs#preparationStatus",
73
78
"type": "ref",
74
79
"description": "A validated, prepared record awaiting its commit, when the domain is already serving an earlier revision."
75
80
}
76
81
}
77
82
},
78
83
"encoding": "application/json"
79
84
},
80
85
"parameters": {
81
86
"type": "params",
82
87
"properties": {
83
88
"uri": {
84
89
"type": "string",
85
90
"format": "at-uri",
86
91
"description": "The record's AT-URI, public or space form. Mutually exclusive with domain."
87
92
},
88
93
"domain": {
89
94
"type": "string",
90
95
"maxLength": 253,
91
96
"description": "The site's hostname. Mutually exclusive with uri."
92
97
}
93
98
}
94
99
},
95
100
"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."
96
101
}
97
102
},
98
103
"$type": "com.atproto.lexicon.schema",
99
104
"lexicon": 1
100
105
}