Lexicon Garden

dev.knotless.getFile

One file at a revision: an image, a binary, too large to show, or text, with the ranges its highlighting paints. The bytes themselves are at the repository's raw path. 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

html

string

A Markdown file made into HTML, as a README is.

kind

requiredstring

How it is shown: only `text` comes with its text.

  • knownValues: image | binary | large | text

lines

requiredinteger
  • minimum: 1

path

requiredstring

The file, from the root.

ranges

string

The ranges its highlighting paints, encoded as the pages read them.

ref

requiredstring

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

size

requiredinteger

In bytes.

  • minimum: 0

text

string

Errors

NotFound

No such repository, revision, path or record.

Similar lexicons

semantic match

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