org.cairnsproto.draft.getReading
The current reading of a project under its policy, with the inputs a client needs to recompute it: every input record's URI, CID and first-seen epoch, and the beacons its draw claims used.
Details · query
| Kind | query |
|---|---|
| Authority | draft.cairnsproto.org |
| Commit rev | 3mzxyqj4ynf2e |
| Indexed |
Query
query · GETParameters
query stringOutput
application/jsonThe indexer's current epoch.
minimum: 0
published
refThe official repo's state, from the latest import result a maintainer published.
sources
arrayOne entry per source hash the project covers or its stones trace back to that a source record names, so a frontend can show a source by name instead of hash. Join it to a site's or gap's source hash.
#beacon
object#candidate
objectProperties
minimum: 0
minimum: 0
minimum: 0
minimum: 0
High bound of the agreement interval, in ppm.
minimum: 0maximum: 1000000
Low bound of the agreement interval, in ppm: support for the share of independent reads that agree on this candidate. It is not a measured accuracy.
minimum: 0maximum: 1000000
Digest of the canonical value.
vouched
booleanPresent and true when a converted stone naming a transform the project vouches for reads this candidate, so its support rests on the maintainer's vouch, not only on independent reads.
#export
objectProperties
#gap
objectA site that is not done. A site no stone has reached yet also names its course and the site itself, and a root-course one its source, so a contributor can place the first stone.
Properties
course
stringCourse id, for a root-course site with no stones.
maxLength: 128
maxLength: 32knownValues: open | contested | tied | ambiguous | belowExport | unreadable | held | escalated
source
refThe source an empty root-course site marks into.
value
refThe site itself, for a site no stone has reached: a root course's whole-source site, or a child site a split course opened.
#input
object#merge
objectThe first maintainer import result holding every file of the export at the same hash.
Properties
maxLength: 64
#published
objectProperties
maxLength: 64
Whether the indexer has the import result's values blob. Sites carry no comparison until it does.
#rejected
object#siteReading
objectProperties
children
arrayWith site: the sites whose base builds on this one, sorted by key.
course
stringThe id of the project course whose schema the site's schema is.
maxLength: 128
error
stringmaxLength: 1000
parent
refThe site a child site's base builds on.
published
stringHow the official repo's value compares with the leading candidate.
maxLength: 32knownValues: matches | diverges
split
booleanWhether the leading value is a split, whose parts are child sites in the same course.
maxLength: 32knownValues: open | contested | tied | ambiguous | leading | unreadable | held | escalated
#sourceSummary
objectA source's MIME type and first URL, from the maintainers' source records before anyone else's, each in URI order. The hash is the identity.
#stoneStatus
objectProperties
maxLength: 32knownValues: leading | pebble | tied | withdrawn | attempt | sealed | unsponsored | branched | unreadable | hollow | excluded
witnesses
arrayWith site: witnesses naming the stone.
#witnessView
objectProperties
maxLength: 32knownValues: checkResult | judgment | recall
verdict
stringA judgment's verdict.
maxLength: 64
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Everything a client needs to recompute a project's reading itself: every input record with its value, the beacons its draw claims used, the epoch each author was first seen in, and the labels of the policy's labelers. A client can drop records before reading, such as stones from sponsors it blocks, without telling the indexer.
-
A signed, pinned reading. Anyone can recompute it from the inputs it lists.
-
Projects the indexer has seen, each at the version it routes under, ranked by need, highest first. Projects a labeler the policy honors, or a labeler the caller names, marks unsafe are left out.
-
Sites a sponsor holds a deliverable draw for: the newest epoch whose retrace window is still open and whose beacon draws the sponsor, for sites not yet past their export bar, in projects where the declared model counts, where the sponsor is eligible and the draw hash falls under the escalated threshold. Each draw carries what a client needs to verify it and do the work. Course-0 sites nobody has opened are listed separately under open, since a first read needs no draw.
-
One project at the version it routes under, with its policy, the procedures its courses name, a newer version waiting out its activation delay, and its forks.