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.
Parameters
Output
application/jsonactivatedAt
stringdatetime
Optional
An RFC 3339 formatted timestamp.
cid
stringcid
Optional
A content identifier (CID) referencing immutable data.
entryCount
integer
Optional
No description available.
errors
array
Required
No description available.
failed
array
Required
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.
fetched
integer
Optional
Blobs fetched and CID-verified so far.
pending
integer
Optional
Blobs still to fetch.
preparation
reflol.dids.defs#preparationStatus
Optional
A validated, prepared record awaiting its commit, when the domain is already serving an earlier revision.
rev
string
Optional
The commit revision of the indexed record.
state
reflol.dids.defs#indexState
Required
No description available.
Errors
RecordNotFound
Bard knows no record at that URI or domain. NotOwner
The record is not the caller's; for a tile URI the caller must be the tile's repo. SpaceNotFound
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. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "RecordNotFound",
"description": "Bard knows no record at that URI or domain."
},
{
"name": "NotOwner",
"description": "The record is not the caller's; for a tile URI the caller must be the tile's repo."
},
{
"name": "SpaceNotFound",
"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."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"state",
"failed",
"errors"
],
"properties": {
"cid": {
"type": "string",
"format": "cid"
},
"rev": {
"type": "string",
"description": "The commit revision of the indexed record."
},
"state": {
"ref": "lol.dids.defs#indexState",
"type": "ref"
},
"errors": {
"type": "array",
"items": {
"ref": "lol.dids.defs#validationError",
"type": "ref"
}
},
"failed": {
"type": "array",
"items": {
"ref": "lol.dids.defs#blobFailure",
"type": "ref"
},
"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."
},
"fetched": {
"type": "integer",
"description": "Blobs fetched and CID-verified so far."
},
"pending": {
"type": "integer",
"description": "Blobs still to fetch."
},
"entryCount": {
"type": "integer"
},
"activatedAt": {
"type": "string",
"format": "datetime"
},
"preparation": {
"ref": "lol.dids.defs#preparationStatus",
"type": "ref",
"description": "A validated, prepared record awaiting its commit, when the domain is already serving an earlier revision."
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"properties": {
"uri": {
"type": "string",
"format": "at-uri",
"description": "The record's AT-URI, public or space form. Mutually exclusive with domain."
},
"domain": {
"type": "string",
"maxLength": 253,
"description": "The site's hostname. Mutually exclusive with uri."
}
}
},
"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."
}