Lexicon Garden

dev.knotless.deleteBranch

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.

Repository @lexicons.knotless.dev did:plc:yqsg7znbbhfmj3a2nrpnaerk namespace authority
Details · procedure
Kindprocedure
Authorityknotless.dev
Indexed
Compare Edit in builder → Fork →
cid bafyreia6zlxwr5gxtrnd4axqiwfwfb6afkrag4d2udrv2i27buhyyhnbdu

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.nameNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.shaNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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"
    }
  },
  "description": "Deletes a branch of a repository.",
  "id": "dev.knotless.deleteBranch",
  "lexicon": 1
}