~ knotless Search/
↑↓ move↵ open⇧↵ all results

chadtmiller.com/knotless

git that lives in your Atmosphere account

knotless.dev
1 collaborator

knotless 0.13.0 Latest 2 packages, 1 image

1
10
47 lines · 2.3 KB Raw History
{
  "lexicon": 1,
  "id": "dev.knotless.listPaths",
  "description": "Every path in a repository's tree at a revision.",
  "defs": {
    "main": {
      "type": "query",
      "description": "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.",
      "parameters": {
        "type": "params",
        "required": ["repo"],
        "properties": {
          "repo": { "type": "string", "format": "at-uri", "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." },
          "ref": { "type": "string", "maxLength": 1024, "description": "A branch, a tag or a commit; the default branch if absent." },
          "limit": { "type": "integer", "minimum": 1, "maximum": 50000, "default": 50000, "description": "The most paths to give: those deepest in the tree are left out first." }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["ref", "paths"],
          "properties": {
            "ref": { "type": "string", "description": "The ref or commit read, as `ref` named it." },
            "paths": {
              "type": "array",
              "items": { "type": "ref", "ref": "#pathView" }
            },
            "truncated": { "type": "boolean", "description": "True when the tree holds more paths than `limit`, and the deepest were left out." }
          }
        }
      },
      "errors": [
        { "name": "NotFound", "description": "No such repository or revision, or a repository never pushed." }
      ]
    },
    "pathView": {
      "type": "object",
      "description": "One path in a tree.",
      "required": ["path", "kind"],
      "properties": {
        "path": { "type": "string", "description": "From the tree's root, with no leading slash." },
        "kind": { "type": "string", "knownValues": ["tree", "blob", "commit"], "description": "A directory, a file, or a submodule's commit." }
      }
    }
  }
}