space.highport.manage.getIndexStatus
Schema Diff
+9 -9
Compatibility Analysis
Backward Compatible
No changes detected.
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
-
"description": "Bard knows no record at that URI or domain."
9
+
"description": "Bard has no record at that URI or domain."
10
10
},
11
11
{
12
12
"name": "NotOwner",
13
-
"description": "The record is not the caller's; for a tile URI the caller must be the tile's repo."
13
+
"description": "The record does not belong to the caller. For a tile URI, the caller must be the tile's repo."
14
14
},
15
15
{
16
16
"name": "SpaceNotFound",
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."
17
+
"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."
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
37
"edge": {
38
38
"ref": "space.highport.defs#edgeReachability",
39
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."
40
+
"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."
41
41
},
42
42
"state": {
43
43
"ref": "space.highport.defs#indexState",
44
44
"type": "ref"
45
45
},
46
46
"errors": {
47
47
"type": "array",
48
48
"items": {
49
49
"ref": "space.highport.defs#validationError",
50
50
"type": "ref"
51
51
}
52
52
},
53
53
"failed": {
54
54
"type": "array",
55
55
"items": {
56
56
"ref": "space.highport.defs#blobFailure",
57
57
"type": "ref"
58
58
},
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."
59
+
"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."
60
60
},
61
61
"fetched": {
62
62
"type": "integer",
63
-
"description": "Blobs fetched and CID-verified so far."
63
+
"description": "Blobs fetched and checked against their CIDs so far."
64
64
},
65
65
"pending": {
66
66
"type": "integer",
67
67
"description": "Blobs still to fetch."
68
68
},
69
69
"entryCount": {
70
70
"type": "integer"
71
71
},
72
72
"activatedAt": {
73
73
"type": "string",
74
74
"format": "datetime"
75
75
},
76
76
"preparation": {
77
77
"ref": "space.highport.defs#preparationStatus",
78
78
"type": "ref",
79
-
"description": "A validated, prepared record awaiting its commit, when the domain is already serving an earlier revision."
79
+
"description": "A validated record waiting to be committed, while the domain still serves an earlier revision."
80
80
}
81
81
}
82
82
},
83
83
"encoding": "application/json"
84
84
},
85
85
"parameters": {
86
86
"type": "params",
87
87
"properties": {
88
88
"uri": {
89
89
"type": "string",
90
90
"format": "at-uri",
91
-
"description": "The record's AT-URI, public or space form. Mutually exclusive with domain."
91
+
"description": "The record's AT-URI, in public or space form. Mutually exclusive with domain."
92
92
},
93
93
"domain": {
94
94
"type": "string",
95
95
"maxLength": 253,
96
96
"description": "The site's hostname. Mutually exclusive with uri."
97
97
}
98
98
}
99
99
},
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."
100
+
"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."
101
101
}
102
102
},
103
103
"$type": "com.atproto.lexicon.schema",
104
104
"lexicon": 1
105
105
}