# dev.knotless.createComment

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

✓ This is the authoritative definition for this NSID.

## Description

Comments on a pull or an issue, or on lines of a pull's diff, or answers a comment, or reviews a pull, as the account logged in to this appview's pages.

## Links

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

## Definitions

### `dev.knotless.createComment#lineComment`

**Type**: `object`

A comment on lines of a pull's diff.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `body` | `string` | Yes | What it says, in Markdown. |
| `line` | `integer` | Yes | The last line commented on, counting from 1, in the file as it is on that side. |
| `path` | `string` | Yes | The file's path on the side commented on. |
| `side` | `string` | No | `new`, the side the pull brings in, or `old`, the side it leaves. Absent, `new`. |
| `startLine` | `integer` | No | The first, for more than one line. |

### `dev.knotless.createComment`

**Type**: `procedure`

Writes a dev.knotless.comment record in the account logged in to this appview's web pages, as `knotless comment` does: with a verdict, a review of the pull's head as it is now. Requires the session cookie the pages' login sets: the appview writes with the session it keeps for that account. Clients holding their own session write the record themselves.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `body` | `string` | Yes | What it says, in Markdown. |
| `images` | `array` | No | Pictures uploaded with dev.knotless.uploadImage; those the body links to are attached. |
| `lines` | `array` | No | Comments on lines of a pull's diff, at its head as it is now, each starting a thread, written at once: as the review's when it has a body or a verdict, else on their own. |
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it. |
| `subject` | `string` (at-uri) | Yes | The dev.knotless.pull or dev.knotless.issue commented on; or a dev.knotless.comment to answer, in the thread it starts or is in. |
| `verdict` | `string` | No | For a review of a pull: `approve`, or `changes` to ask for changes. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes | The dev.knotless.comment record written: with lines, the review, or without one the first line comment. |

#### Errors

- **NotFound**: No such repository.
- **AuthenticationRequired**: No account is logged in to the pages, or its session has ended.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "lineComment": {
      "description": "A comment on lines of a pull's diff.",
      "properties": {
        "body": {
          "description": "What it says, in Markdown.",
          "maxLength": 20000,
          "type": "string"
        },
        "line": {
          "description": "The last line commented on, counting from 1, in the file as it is on that side.",
          "minimum": 1,
          "type": "integer"
        },
        "path": {
          "description": "The file's path on the side commented on.",
          "maxLength": 1024,
          "type": "string"
        },
        "side": {
          "description": "`new`, the side the pull brings in, or `old`, the side it leaves. Absent, `new`.",
          "knownValues": [
            "old",
            "new"
          ],
          "maxLength": 16,
          "type": "string"
        },
        "startLine": {
          "description": "The first, for more than one line.",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "path",
        "line",
        "body"
      ],
      "type": "object"
    },
    "main": {
      "description": "Writes a dev.knotless.comment record in the account logged in to this appview's web pages, as `knotless comment` does: with a verdict, a review of the pull's head as it is now. Requires the session cookie the pages' login sets: the appview writes with the session it keeps for that account. Clients holding their own session write the record themselves.",
      "errors": [
        {
          "description": "No such repository.",
          "name": "NotFound"
        },
        {
          "description": "No account is logged in to the pages, or its session has ended.",
          "name": "AuthenticationRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "body": {
              "description": "What it says, in Markdown.",
              "maxLength": 20000,
              "type": "string"
            },
            "images": {
              "description": "Pictures uploaded with dev.knotless.uploadImage; those the body links to are attached.",
              "items": {
                "ref": "dev.knotless.defs#image",
                "type": "ref"
              },
              "maxLength": 32,
              "type": "array"
            },
            "lines": {
              "description": "Comments on lines of a pull's diff, at its head as it is now, each starting a thread, written at once: as the review's when it has a body or a verdict, else on their own.",
              "items": {
                "ref": "#lineComment",
                "type": "ref"
              },
              "maxLength": 100,
              "type": "array"
            },
            "repo": {
              "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
              "format": "at-uri",
              "type": "string"
            },
            "subject": {
              "description": "The dev.knotless.pull or dev.knotless.issue commented on; or a dev.knotless.comment to answer, in the thread it starts or is in.",
              "format": "at-uri",
              "type": "string"
            },
            "verdict": {
              "description": "For a review of a pull: `approve`, or `changes` to ask for changes.",
              "knownValues": [
                "approve",
                "changes"
              ],
              "maxLength": 64,
              "type": "string"
            }
          },
          "required": [
            "repo",
            "subject",
            "body"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "uri": {
              "description": "The dev.knotless.comment record written: with lines, the review, or without one the first line comment.",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "uri"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "description": "Comments on a pull or an issue, or on lines of a pull's diff, or answers a comment, or reviews a pull, as the account logged in to this appview's pages.",
  "id": "dev.knotless.createComment",
  "lexicon": 1
}
```