space.highport.manage.getIndexStatus
Schema Diff
+9 -9
Compatibility Analysis
Backward Compatible
No changes detected.
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
32
"edge": {
33
-
"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.",
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
34
"ref": "space.highport.defs#edgeReachability",
35
35
"type": "ref"
36
36
},
37
37
"entryCount": {
38
38
"type": "integer"
39
39
},
40
40
"errors": {
41
41
"items": {
42
42
"ref": "space.highport.defs#validationError",
43
43
"type": "ref"
44
44
},
45
45
"type": "array"
46
46
},
47
47
"failed": {
48
-
"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.",
49
49
"items": {
50
50
"ref": "space.highport.defs#blobFailure",
51
51
"type": "ref"
52
52
},
53
53
"type": "array"
54
54
},
55
55
"fetched": {
56
-
"description": "Blobs fetched and CID-verified so far.",
56
+
"description": "Blobs fetched and checked against their CIDs so far.",
57
57
"type": "integer"
58
58
},
59
59
"pending": {
60
60
"description": "Blobs still to fetch.",
61
61
"type": "integer"
62
62
},
63
63
"preparation": {
64
-
"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.",
65
65
"ref": "space.highport.defs#preparationStatus",
66
66
"type": "ref"
67
67
},
68
68
"rev": {
69
69
"description": "The commit revision of the indexed record.",
70
70
"type": "string"
71
71
},
72
72
"state": {
73
73
"ref": "space.highport.defs#indexState",
74
74
"type": "ref"
75
75
}
76
76
},
77
77
"required": [
78
78
"state",
79
79
"failed",
80
80
"errors"
81
81
],
82
82
"type": "object"
83
83
}
84
84
},
85
85
"parameters": {
86
86
"properties": {
87
87
"domain": {
88
88
"description": "The site's hostname. Mutually exclusive with uri.",
89
89
"maxLength": 253,
90
90
"type": "string"
91
91
},
92
92
"uri": {
93
-
"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.",
94
94
"format": "at-uri",
95
95
"type": "string"
96
96
}
97
97
},
98
98
"type": "params"
99
99
},
100
100
"type": "query"
101
101
}
102
102
},
103
103
"id": "space.highport.manage.getIndexStatus",
104
104
"lexicon": 1
105
105
}