Note kit command

comment.resolve

Resolve a comment thread

Marks the comment thread `thread` resolved, or open again with `resolved: false`.

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.resolve
NameTypeRequiredDescription
resolvedbooleannoResolved, or open again.
threadstringyesThe thread's id.

Call through note_run

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

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

Result

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

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "resolved": {
      "default": true,
      "description": "Resolved, or open again.",
      "type": "boolean"
    },
    "thread": {
      "description": "The thread's id.",
      "type": "string",
      "x-khp-types": [
        "CommentThread"
      ]
    }
  },
  "required": [
    "thread"
  ],
  "type": "object"
}

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