dev.knotless.getTree

lexicons.knotless.dev

Documentation

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.

main query

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.

Parameters

path string Optional

A path in the tree, from its root.

ref string Optional

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

repo string at-uri Required

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

Encodingapplication/json
checks array Required

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

empty boolean Optional

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

entries array Required

No description available.

languages array Required

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

path string Required

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

readme ref#readme Optional

No description available.

ref string Required

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

Errors

NotFound No such repository, revision, path or record.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
A path in the tree, from its root.
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`.
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.
View raw schema 
{
  "description": "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.",
  "errors": [
    {
      "description": "No such repository, revision, path or record.",
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "checks": {
          "description": "The newest run of each workflow at `lastCommit`, by the runners the repository names: the revision shown, at the root.",
          "items": {
            "ref": "dev.knotless.defs#checkView",
            "type": "ref"
          },
          "type": "array"
        },
        "empty": {
          "description": "True for a repository never pushed, whose tree is nothing.",
          "type": "boolean"
        },
        "entries": {
          "items": {
            "ref": "#entry",
            "type": "ref"
          },
          "type": "array"
        },
        "languages": {
          "description": "What the repository is written in, most first: at the root of its default branch, and nowhere else.",
          "items": {
            "ref": "dev.knotless.defs#languageView",
            "type": "ref"
          },
          "type": "array"
        },
        "lastCommit": {
          "description": "The newest commit that changed the directory.",
          "ref": "dev.knotless.defs#commitView",
          "type": "ref"
        },
        "path": {
          "description": "The directory, from the root; empty for the root.",
          "type": "string"
        },
        "readme": {
          "ref": "#readme",
          "type": "ref"
        },
        "ref": {
          "description": "The ref or commit shown, as `ref` named it, less any path.",
          "type": "string"
        }
      },
      "required": [
        "ref",
        "path",
        "entries",
        "checks",
        "languages"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "path": {
        "description": "A path in the tree, from its root.",
        "maxLength": 4096,
        "type": "string"
      },
      "ref": {
        "description": "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,
        "type": "string"
      },
      "repo": {
        "description": "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.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "repo"
    ],
    "type": "params"
  },
  "type": "query"
}
entry object

One entry of a directory.

Properties

kind string Required

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

Known values: tree, blob, commit
name string Required

No description available.

size integer Optional

A file's size, in bytes.

minimum: 0
View raw schema 
{
  "description": "One entry of a directory.",
  "properties": {
    "kind": {
      "description": "A directory, a file, or a submodule's commit.",
      "knownValues": [
        "tree",
        "blob",
        "commit"
      ],
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "size": {
      "description": "A file's size, in bytes.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "name",
    "kind"
  ],
  "type": "object"
}
readme object

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

Properties

html string Optional

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

name string Required

Its file name.

text string Optional

Any other README, as it is.

View raw schema 
{
  "description": "The directory's README: the first file whose name starts with `readme`, ignoring case.",
  "properties": {
    "html": {
      "description": "A Markdown README, made into HTML: raw HTML shown as text, and links made relative to the directory.",
      "type": "string"
    },
    "name": {
      "description": "Its file name.",
      "type": "string"
    },
    "text": {
      "description": "Any other README, as it is.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Lexicon Garden

@