dev.knotless.deleteBranch

lexicons.knotless.dev

Documentation

Deletes a branch, never the default one, as `knotless branch --delete` does. As the account logged in to this appview's web pages: directly for the owner, through the repository's gateway for a collaborator, which refuses anyone else.

main procedure

Deletes a branch, never the default one, as `knotless branch --delete` does. As the account logged in to this appview's web pages: directly for the owner, through the repository's gateway for a collaborator, which refuses anyone else.

Input

Encodingapplication/json
name string Required

The branch, without refs/heads/.

maxLength: 255 bytes
repo stringat-uri Required

The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

Output

Encodingapplication/json
name string Required

The branch, without refs/heads/.

sha string Optional

The commit it points at, in hex, once made.

Errors

NotFound No such repository.
InvalidRequest There is no such branch, it is the default branch, or the gateway refused it.
AuthenticationRequired No account is logged in to the pages, or its session has ended.
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://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Deletes a branch, never the default one, as `knotless branch --delete` does. As the account logged in to this appview's web pages: directly for the owner, through the repository's gateway for a collaborator, which refuses anyone else.",
  "errors": [
    {
      "description": "No such repository.",
      "name": "NotFound"
    },
    {
      "description": "There is no such branch, it is the default branch, or the gateway refused it.",
      "name": "InvalidRequest"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "name": {
          "description": "The branch, without refs/heads/.",
          "maxLength": 255,
          "type": "string"
        },
        "repo": {
          "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "repo",
        "name"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "name": {
          "description": "The branch, without refs/heads/.",
          "type": "string"
        },
        "sha": {
          "description": "The commit it points at, in hex, once made.",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@