# dev.knotless.protectBranch

> Published by [lexicons.knotless.dev](https://lexicon.garden/identity/did:plc:yqsg7znbbhfmj3a2nrpnaerk)

✓ This is the authoritative definition for this NSID.

## Description

Protects a branch of a repository.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.protectBranch)
- [Documentation](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.protectBranch/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.protectBranch/examples)

## Definitions

### `dev.knotless.protectBranch`

**Type**: `procedure`

Adds the branch to the protected branches of the repository's dev.knotless.repo record, in place of any rule it had, as `knotless protect` does: through the gateway it then only moves forward, is never deleted, and unless merges is set takes no merge commits; with queue, pulls land on it only through the merge queue; with reviews, a pull merges into it only once reviewed as they ask. Only its owner, logged in to this appview's web pages, can: the appview writes with the session it keeps for that account, which the pages' session cookie names.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `branch` | `string` | Yes | The branch, without refs/heads/. |
| `merges` | `boolean` | No | Whether it takes merge commits; otherwise pulls merge into it squashed. |
| `queue` | `boolean` | No | Whether pulls land on it only through the merge queue. |
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it. |
| `reviews` | `ref` → `dev.knotless.repo#reviews` | No | The reviews a pull needs before it merges into the branch. Absent, none. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `rules` | `array` | Yes | The protected branches now. |

#### Errors

- **NotFound**: No such repository.
- **AuthenticationRequired**: No account is logged in to the pages, or its session has ended.
- **Forbidden**: The account logged in is not the repository's owner.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Adds the branch to the protected branches of the repository's dev.knotless.repo record, in place of any rule it had, as `knotless protect` does: through the gateway it then only moves forward, is never deleted, and unless merges is set takes no merge commits; with queue, pulls land on it only through the merge queue; with reviews, a pull merges into it only once reviewed as they ask. Only its owner, logged in to this appview's web pages, can: the appview writes with the session it keeps for that account, which the pages' session cookie names.",
      "errors": [
        {
          "description": "No such repository.",
          "name": "NotFound"
        },
        {
          "description": "No account is logged in to the pages, or its session has ended.",
          "name": "AuthenticationRequired"
        },
        {
          "description": "The account logged in is not the repository's owner.",
          "name": "Forbidden"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "branch": {
              "description": "The branch, without refs/heads/.",
              "maxLength": 255,
              "type": "string"
            },
            "merges": {
              "description": "Whether it takes merge commits; otherwise pulls merge into it squashed.",
              "type": "boolean"
            },
            "queue": {
              "description": "Whether pulls land on it only through the merge queue.",
              "type": "boolean"
            },
            "repo": {
              "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
              "format": "at-uri",
              "type": "string"
            },
            "reviews": {
              "description": "The reviews a pull needs before it merges into the branch. Absent, none.",
              "ref": "dev.knotless.repo#reviews",
              "type": "ref"
            }
          },
          "required": [
            "repo",
            "branch"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "rules": {
              "description": "The protected branches now.",
              "items": {
                "ref": "dev.knotless.repo#rule",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "rules"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "description": "Protects a branch of a repository.",
  "id": "dev.knotless.protectBranch",
  "lexicon": 1
}
```