dev.knotless.listPaths

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