dev.knotless.listBranches

lexicons.knotless.dev

Documentation

A repository's branches, the default first and the rest by name, a page at a time: follow `cursor` until it is absent. 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 repository's branches, the default first and the rest by name, a page at a time: follow `cursor` until it is absent. 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

commits boolean Optional

Each branch's tip commit and its checks too, as a page of branches shows them, rather than its name alone, as a menu of them does.

cursor string Optional

How many branches the pages before held.

limit integer Optional

No description available.

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
branches array Required

No description available.

cursor string Optional

Absent on the last page.

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
Each branch's tip commit and its checks too, as a page of branches shows them, rather than its name alone, as a menu of them does.
How many branches the pages before held.
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 repository's branches, the default first and the rest by name, a page at a time: follow `cursor` until it is absent. 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": {
        "branches": {
          "items": {
            "ref": "#branchView",
            "type": "ref"
          },
          "type": "array"
        },
        "cursor": {
          "description": "Absent on the last page.",
          "type": "string"
        }
      },
      "required": [
        "branches"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "commits": {
        "default": false,
        "description": "Each branch's tip commit and its checks too, as a page of branches shows them, rather than its name alone, as a menu of them does.",
        "type": "boolean"
      },
      "cursor": {
        "description": "How many branches the pages before held.",
        "maxLength": 32,
        "type": "string"
      },
      "limit": {
        "default": 100,
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      },
      "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"
}
branchView object

One branch.

Properties

checks array of refdev.knotless.defs#checkView Optional

The newest run of each workflow at its tip, by the runners the repository names, when `commits` was asked.

name string Required

Its short name, without `refs/heads/`.

View raw schema 
{
  "description": "One branch.",
  "properties": {
    "checks": {
      "description": "The newest run of each workflow at its tip, by the runners the repository names, when `commits` was asked.",
      "items": {
        "ref": "dev.knotless.defs#checkView",
        "type": "ref"
      },
      "type": "array"
    },
    "commit": {
      "description": "Its tip, when `commits` was asked.",
      "ref": "dev.knotless.defs#commitView",
      "type": "ref"
    },
    "name": {
      "description": "Its short name, without `refs/heads/`.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Lexicon Garden

@