dev.knotless.comment

lexicons.knotless.dev

Documentation

Kept in the commenter's account; for a private repository, in their repo inside the repository's space.

main record

Kept in the commenter's account; for a private repository, in their repo inside the repository's space.

Record Key tid Timestamp-based ID

Properties

attachments array of union Optional

What it carries beside its body: the pictures the body shows. Kinds unknown to a reader are passed over, and kept by a client changing it.

maxLength: 32 items
Known types:
body string Required

Markdown.

maxLength: 20000 bytes
commit string Optional

The hex object ID of the head commit a review looked at, or that a comment's `line` is in.

maxLength: 64 bytesminLength: 40 bytes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

facets array of ref dev.knotless.defs#facet Optional

The accounts its body mentions, by where: written as it is, from each `@handle` outside code and links.

maxLength: 50 items
line ref #lineRef Optional

For a comment on a pull's diff, the lines it is on, in the file as it was at `commit` on that side.

reply string at-uri Optional

The dev.knotless.comment, with a `line`, whose thread this answers. An answer has no `line` of its own.

review string at-uri Optional

The review, a dev.knotless.comment, this was sent with as one of its line comments, all in one write.

subject string at-uri Required

The dev.knotless.pull or dev.knotless.issue commented on.

updatedAt string datetime Optional

When its author last changed its body.

verdict string Optional

Present on a review: `approve`, or `changes` to ask for changes. Readers take each reviewer's latest as where they stand, and none from the pull's author.

maxLength: 64 bytes
Known values: approve, changes
View raw schema 
{
  "description": "Kept in the commenter's account; for a private repository, in their repo inside the repository's space.",
  "key": "tid",
  "record": {
    "properties": {
      "attachments": {
        "description": "What it carries beside its body: the pictures the body shows. Kinds unknown to a reader are passed over, and kept by a client changing it.",
        "items": {
          "refs": [
            "dev.knotless.defs#image"
          ],
          "type": "union"
        },
        "maxLength": 32,
        "type": "array"
      },
      "body": {
        "description": "Markdown.",
        "maxLength": 20000,
        "type": "string"
      },
      "commit": {
        "description": "The hex object ID of the head commit a review looked at, or that a comment's `line` is in.",
        "maxLength": 64,
        "minLength": 40,
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "facets": {
        "description": "The accounts its body mentions, by where: written as it is, from each `@handle` outside code and links.",
        "items": {
          "ref": "dev.knotless.defs#facet",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "line": {
        "description": "For a comment on a pull's diff, the lines it is on, in the file as it was at `commit` on that side.",
        "ref": "#lineRef",
        "type": "ref"
      },
      "reply": {
        "description": "The dev.knotless.comment, with a `line`, whose thread this answers. An answer has no `line` of its own.",
        "format": "at-uri",
        "type": "string"
      },
      "repo": {
        "description": "The repository the pull or issue is on.",
        "ref": "dev.knotless.defs#repoRef",
        "type": "ref"
      },
      "review": {
        "description": "The review, a dev.knotless.comment, this was sent with as one of its line comments, all in one write.",
        "format": "at-uri",
        "type": "string"
      },
      "subject": {
        "description": "The dev.knotless.pull or dev.knotless.issue commented on.",
        "format": "at-uri",
        "type": "string"
      },
      "updatedAt": {
        "description": "When its author last changed its body.",
        "format": "datetime",
        "type": "string"
      },
      "verdict": {
        "description": "Present on a review: `approve`, or `changes` to ask for changes. Readers take each reviewer's latest as where they stand, and none from the pull's author.",
        "knownValues": [
          "approve",
          "changes"
        ],
        "maxLength": 64,
        "type": "string"
      }
    },
    "required": [
      "repo",
      "subject",
      "body",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
lineRef object

Lines of a file in a pull's diff, as GitHub's review comments name them.

Properties

line integer Required

The last line commented on, counting from 1.

minimum: 1
path string Required

The file's path on the side commented on.

maxLength: 1024 bytes
side string Optional

`new`, the side the pull brings in, or `old`, the side it leaves, for lines it removes. Absent, `new`.

maxLength: 16 bytes
Known values: old, new
startLine integer Optional

The first, for more than one line; no later than `line`.

minimum: 1
View raw schema 
{
  "description": "Lines of a file in a pull's diff, as GitHub's review comments name them.",
  "properties": {
    "line": {
      "description": "The last line commented on, counting from 1.",
      "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, for lines it removes. Absent, `new`.",
      "knownValues": [
        "old",
        "new"
      ],
      "maxLength": 16,
      "type": "string"
    },
    "startLine": {
      "description": "The first, for more than one line; no later than `line`.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "path",
    "line"
  ],
  "type": "object"
}

Lexicon Garden

@