Lexicon Garden

org.cairnsproto.draft.project

Maintainers, a scope, a stack of courses and a policy.

Repository @cairnsproto.org did:plc:np7ezqujtsry4bkogisaabul namespace authority
Details · record, key tid
Kindrecord
Record keytid
Authoritydraft.cairnsproto.org
Indexed
Compare Edit in builder → Fork →

Record

record · key tid

Properties

courses

requiredarray
  • minLength: 1
  • maxLength: 64
itemsref
Reference

createdAt

requiredstring · datetime

description

string
  • maxLength: 30000
  • maxGraphemes: 3000

maintainers

requiredarray
  • minLength: 1
  • maxLength: 32
itemsstring · did

mounts

array
  • maxLength: 64
itemsref
Reference

name

string
  • maxLength: 640
  • maxGraphemes: 64

outputSchema

ref

Hash of the export's schema definition.

Reference

policy

requiredref
Reference

publish

ref
Reference

scope

requiredunion
One of

status

requiredstring
  • maxLength: 32
  • knownValues: active | complete | archived

succeededBy

ref

Set together with status archived when adopting another fork.

Reference

tags

array

Discovery tags, lowercase kebab-case.

  • maxLength: 10
itemsstring
  • maxLength: 64

transforms

array

Transform records the maintainer vouches for. Clients run them, and their output needs no reads.

  • maxLength: 64
itemsref
Reference

#builtinComposer

object

A composer every client implements. concat: every array field is the parts' arrays joined in part order, and every other field must be equal in all parts.

Properties

name

requiredstring
  • maxLength: 64
  • knownValues: concat

#checkComposer

object

A WASM check that rebuilds a split site's value from its parts' values, in part order.

Properties

check

requiredref
Reference

#course

object

Properties

bounds

requiredstring

closed allows null stones; open allows only attempts.

  • maxLength: 32
  • knownValues: closed | open

compose

union

How a split site's value is rebuilt from its parts' values. Absent means the course is atomic, and its sites can't be split.

One of

id

requiredstring
  • maxLength: 128

markType

requiredstring

Mark def reference, such as org.cairnsproto.draft.mark#pdfRegion.

  • maxLength: 512

parent

string

Id of the course below. Absent for course 0.

  • maxLength: 128

procedure

ref

The procedure for this course's sites.

Reference

schema

requiredref

Hash of the payload schema's definition. Part of every site key in the course.

Reference

schemaRecord

requiredref

An org.cairnsproto.draft.schema record whose definition has the schema hash, in any repo.

Reference

split

string

How a parent value breaks down into this course's sites: a JSON pointer to an array in the parent value, with one site per element, marked by a jsonPointer to that element (`/contests/0`, `/contests/1`, ...). Only for a course with a parent and markType jsonPointer. A site opens when the parent value clears the open-children bar. Without a split, a course opens one unmarked site on each parent conversion that clears the bar, and none on other values.

  • maxLength: 512

#enumeratedScope

object

The course-0 sites are a fixed list.

Properties

sites

ref

Optional explicit list of course-0 site keys, one hex key per line.

Reference

sources

requiredarray

Source hashes the project covers.

  • maxLength: 10000
itemsref
Reference

#mount

object

Builds on another project's snapshot.

Properties

course

requiredstring
  • maxLength: 128

project

requiredref
Reference

snapshot

requiredref
Reference

#openScope

object

Anyone may open new course-0 sites, such as hypothesis sites.

Properties

#publish

object

The official repo the project's output feeds, and how values become its files.

Properties

branch

requiredstring
  • maxLength: 256

format

requiredstring

Output format, such as csv.

  • maxLength: 64

import

ref

Check that maps the repo's published files back to site keys and values.

Reference

license

requiredstring

SPDX expression or URL for the output.

  • maxLength: 512

path

requiredstring

Directory in the repo the files go in.

  • maxLength: 4096

render

requiredref

Check that renders a snapshot's exported values into files.

Reference

repo

requiredstring

Git URL.

  • maxLength: 2048

Similar lexicons

semantic match

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

  • org.cairnsproto.draft.getProject

    query

    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.