dev.knotless.createComment

Writes a dev.knotless.comment record in the account logged in to this appview's web pages, as `knotless comment add` 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.

Details · procedure
Kindprocedure
Authorityknotless.dev
Indexed

Procedure

procedure · POST

Input

application/json

body

requiredstring

What it says, in Markdown.

  • maxLength: 20000

images

array

Pictures uploaded with dev.knotless.uploadImage; those the body links to are attached.

  • maxLength: 32
itemsref

lines

array

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.

  • maxLength: 100
itemsref
Reference

repo

requiredstring · at-uri

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

subject

requiredstring · at-uri

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

For a review of a pull: `approve`, or `changes` to ask for changes.

  • maxLength: 64
  • knownValues: approve | changes

Output

application/json

uri

requiredstring · at-uri

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.

#lineComment

object

A comment on lines of a pull's diff.

Properties

body

requiredstring

What it says, in Markdown.

  • maxLength: 20000

line

requiredinteger

The last line commented on, counting from 1, in the file as it is on that side.

  • minimum: 1

path

requiredstring

The file's path on the side commented on.

  • maxLength: 1024

side

string

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

  • maxLength: 16
  • knownValues: old | new

startLine

integer

The first, for more than one line.

  • minimum: 1

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • A comment on a pull or issue. With a verdict it is a review; with a line, a comment on lines of a pull's diff, starting a thread there; with a reply, an answer in such a thread.

  • Reacts to a pull, an issue or a comment as the account logged in to this appview's pages.

  • Changes what a pull, an issue or a comment says, as its author, logged in to this appview's pages.

  • Opens a pull on a repository, as the account logged in to this appview's pages.

  • Takes back a comment or review, as its author, logged in to this appview's pages.