Lexicon Garden

dev.knotless.getTree

A directory at a revision: its entries, folders first, the commit that last changed it, its README, and what the repository's runners report of the revision. Nothing at all, for a repository never pushed. No authentication needed; asked as an account, with a service token or the pages' session cookie, a private repository it is a member of is read too, and the answer is that account's alone.

Repository @lexicons.knotless.dev did:plc:yqsg7znbbhfmj3a2nrpnaerk namespace authority
Details · query
Kindquery
Authorityknotless.dev
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

path

string

A path in the tree, from its root.

  • maxLength: 4096

ref

string

A branch, a tag or a commit; the default branch if absent. It may run on into the path, as a web address names them: the longest branch or tag that starts it is the ref, and what follows goes before `path`.

  • maxLength: 1024

repo

requiredstring · at-uri

The repository's dev.knotless.repo record. Its authority may be a handle; a name the repository had before, or an owner it moved from with its agreement, finds it under the name it has now.

Output

application/json

checks

requiredarray

The newest run of each workflow at `lastCommit`, by the runners the repository names: the revision shown, at the root.

itemsref
Reference

empty

boolean

True for a repository never pushed, whose tree is nothing.

entries

requiredarray
itemsref
Reference

languages

requiredarray

What the repository is written in, most first: at the root of its default branch, and nowhere else.

itemsref
Reference

lastCommit

ref

The newest commit that changed the directory.

Reference

path

requiredstring

The directory, from the root; empty for the root.

readme

ref
Reference

ref

requiredstring

The ref or commit shown, as `ref` named it, less any path.

Errors

NotFound

No such repository, revision, path or record.

#entry

object

One entry of a directory.

Properties

kind

requiredstring

A directory, a file, or a submodule's commit.

  • knownValues: tree | blob | commit

name

requiredstring

size

integer

A file's size, in bytes.

  • minimum: 0

#readme

object

The directory's README: the first file whose name starts with `readme`, ignoring case.

Properties

html

string

A Markdown README, made into HTML: raw HTML shown as text, and links made relative to the directory.

name

requiredstring

Its file name.

text

string

Any other README, as it is.

Similar lexicons

semantic match

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