Note kit command

comment.reply

Reply to a comment

Adds a reply to the comment thread `thread` and answers the new comment's id.

Kit
Note 0.3.0 (Markdown (.md))
Changes the document
yes
Acts on
thread (one id), which a run step’s on fills

Parameters

Parameters of comment.reply
NameTypeRequiredDescription
authorstringnoThe caller's own principal id (the default); the editor's person passes theirs, and another is refused.
bodystringyesThe reply's text.
createdstringnoWhen, ISO 8601 UTC; now by default.
namestringnoThe author's display name.
threadstringyesThe thread's id.

Call through note_run

text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "comment.reply", "params": { "body": <string>, "thread": <string> } }]
}

The required parameters, with placeholders for their types: not a tested example. Optional: author, created, name. note_run answers the step’s result in completed[i].result.

Result

Result of comment.reply
NameTypeRequiredDescription
commentstringyesThe new comment's id.
threadstringyesThe thread's id.
Result JSON Schema
json
{
  "additionalProperties": false,
  "properties": {
    "comment": {
      "description": "The new comment's id.",
      "type": "string"
    },
    "thread": {
      "description": "The thread's id.",
      "type": "string"
    }
  },
  "required": [
    "comment",
    "thread"
  ],
  "type": "object"
}

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "author": {
      "description": "The caller's own principal id (the default); the editor's person passes theirs, and another is refused.",
      "type": "string"
    },
    "body": {
      "description": "The reply's text.",
      "type": "string"
    },
    "created": {
      "description": "When, ISO 8601 UTC; now by default.",
      "type": "string"
    },
    "name": {
      "description": "The author's display name.",
      "type": "string"
    },
    "thread": {
      "description": "The thread's id.",
      "type": "string",
      "x-khp-types": [
        "CommentThread"
      ]
    }
  },
  "required": [
    "body",
    "thread"
  ],
  "type": "object"
}

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.