dev.knotless.listPaths

Every path in a repository's tree at a revision, folders as well as files, the shallowest first: for finding a file by name as it is typed. 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.

Details · query
Kindquery
Authorityknotless.dev
Indexed

Query

query · GET

Parameters

query string

limit

integer

The most paths to give: those deepest in the tree are left out first.

  • minimum: 1
  • maximum: 50000
  • default: 50000

ref

string

A branch, a tag or a commit; the default branch if absent.

  • 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

paths

requiredarray
itemsref
Reference

ref

requiredstring

The ref or commit read, as `ref` named it.

truncated

boolean

True when the tree holds more paths than `limit`, and the deepest were left out.

Errors

NotFound

No such repository or revision, or a repository never pushed.

#pathView

object

One path in a tree.

Properties

kind

requiredstring

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

  • knownValues: tree | blob | commit

path

requiredstring

From the tree's root, with no leading slash.

Similar lexicons

semantic match

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