org.cairnsproto.draft.listProjects

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.

Repository @cairnsproto.org did:plc:np7ezqujtsry4bkogisaabul namespace authority
Details · query
Kindquery
Authoritydraft.cairnsproto.org
Commit rev3mzxyqlmgl32l
Indexed

Query

query · GET

Parameters

query string

cursor

string
  • maxLength: 512

follower

string · did

Keep projects where a sponsor this DID follows, or one of that sponsor's agents, has a stone, and name those sponsors in each view's followed.

label

string

Keep projects that a labeler named in labeler marks with this value, such as featured.

  • maxLength: 128

labeler

array

Labelers the caller honors on top of each policy's, as a consumer overlay. Their unsafe hides a project and their other labels are listed under consumerLabels. The indexer serves only labelers its operator tracks and rejects others.

  • maxLength: 4
itemsstring · did

limit

integer
  • minimum: 1
  • maximum: 100
  • default: 50

model

string

The declared model family. Projects whose policy gives it no weight are left out.

  • maxLength: 256
  • maxLength: 128

status

string

Keep projects with this status, such as active.

  • maxLength: 32

tag

array

Keep projects carrying every one of these tags, from the maintainer or from a labeler the policy honors.

  • maxLength: 10
itemsstring
  • maxLength: 128

thinking

string
  • maxLength: 64

Output

application/json

cursor

string
  • maxLength: 512

With labeler: whether the indexer holds labels from each named labeler, so a client can fail closed when it doesn't.

itemsref
Reference

projects

requiredarray
itemsref
Reference

#consumerLabel

object

Properties

labeler

requiredstring · did

val

requiredstring
  • maxLength: 128

#costTotals

object

Properties

cachedTokens

requiredinteger
  • minimum: 0

inputTokens

requiredinteger
  • minimum: 0

outputTokens

requiredinteger
  • minimum: 0

seconds

requiredinteger
  • minimum: 0

#courseCost

object

What stones in one course from one declared model report in method.cost. Self-reported and advisory.

Properties

course

requiredstring
  • maxLength: 128

median

requiredref

Each field's lower median over those stones.

Reference

model

requiredstring
  • maxLength: 256

open

requiredinteger

Sites in the course that still take work, including sites no stone has reached.

  • minimum: 0

stones

requiredinteger

Stones in the reading that report a cost.

  • minimum: 1

toFinish

requiredref

open times each median.

Reference

#courseProgress

object

Each site of one course in exactly one of open, contested, ambiguous, belowExport, pastExport and held. diverges counts the sites whose leading value differs from the official repo's, whatever their bucket.

Properties

ambiguous

requiredinteger
  • minimum: 0

belowExport

requiredinteger
  • minimum: 0

contested

requiredinteger
  • minimum: 0

course

requiredstring
  • maxLength: 128

diverges

requiredinteger
  • minimum: 0

held

requiredinteger
  • minimum: 0

open

requiredinteger
  • minimum: 0

pastExport

requiredinteger
  • minimum: 0

#dormancy

object

Properties

oldest

requiredref
Reference

pending

requiredinteger

How many items of maintainer-only work are pending.

  • minimum: 1

sinceRound

requiredinteger

Quicknet round the project went dormant: the oldest pending item's due round plus the dormancy period.

  • minimum: 0

#labelTag

object

Properties

labeler

requiredstring · did

name

requiredstring

The tag, without its tag: prefix.

  • maxLength: 128

#labelerState

object

Properties

did

requiredstring · did

error

string

Why the last fetch failed, if it did.

  • maxLength: 1000

loaded

requiredboolean

Whether a fetch from this labeler has ever succeeded.

refreshedAt

string · datetime

When the last successful fetch finished.

#pendingWork

object

Properties

kind

requiredstring
  • maxLength: 32
  • knownValues: issue | snapshot | gold | unsafe

sinceRound

requiredinteger

Quicknet round the item became due.

  • minimum: 0

subject

requiredref

The issue, the latest snapshot or the project, the unrevealed gold commitment, or the unsafe-labeled project or policy version.

#projectView

object

Properties

With dormant: the soft fork to show alongside, at the version it routes under: the one forked from this project, or this project was forked from, with the same courses and schemas, not dormant, and with the most maintainer snapshots in the dormancy period.

anyModel

boolean

Whether the policy gives weight to models it doesn't list.

With labeler: labels in force on the project or its policy from the labelers the caller named.

itemsref
Reference

costs

array

Median self-reported cost per site for each course and declared model, with an estimate to finish. Absent when the project can't be read.

itemsref
Reference
  • maxLength: 30000
  • maxGraphemes: 3000

Present when maintainer-only work has waited unanswered for the policy's dormancy period.

Reference

With follower: the followed sponsors who work the project, through their own stones or their agents'.

itemsstring · did

Tags from labelers the policy honors, kept apart from the maintainer's.

itemsref
Reference

license

string

The license of the official repo's published data.

  • maxLength: 512

maintainers

requiredarray
itemsstring · did

Model families the policy gives weight, sorted.

itemsstring
  • maxLength: 256

name

string
  • maxLength: 640

need

integer

The sum of the need of each open or contested site. Absent when the project can't be read.

  • minimum: 0

policy

requiredref

Site counts per course, in the project's course order, from the reading need comes from. Left out when that reading fails.

itemsref
Reference

project

requiredref

The Git URL of the official repo exports are published to.

  • maxLength: 2048

seenRound

requiredinteger

Quicknet round when the indexer first saw this version of the project.

  • minimum: 1

status

requiredstring
  • maxLength: 32

tags

array

The maintainer's tags.

itemsstring
  • maxLength: 64

How current each timekeeper the policy names is, so a contributor can tell when snapshots will lag.

itemsref
Reference

#timekeeper

object

Properties

did

requiredstring · did

lagRounds

integer

How many rounds before now that is.

  • minimum: 0

The round the timekeeper's latest seen record runs through. Absent before its first.

  • minimum: 0

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • 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.

  • 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.

  • 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.