Skip to content

Update from code changes: document suggestion payload on V2 comment annotations #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update from code changes: document suggestion payload on V2 comment annotations #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16d5d3c
docs: document suggestion payload on V2 comment annotations
mintlify[bot] Jul 20, 2026
b7873a8
docs: add SEO descriptions to V2 comment annotations add/update pages
mintlify[bot] Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions ...e/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Add Comment Annotations"
description: "Create V2 comment annotations via REST — plain comments, agent findings, suggestions with a proposed-change payload, and private annotations."
api: "POST https://api.velt.dev/v2/commentannotations/add"
---

Expand Down Expand Up @@ -301,6 +302,32 @@ Use this API to add comment annotations to a document within an organization.
Annotation kind. Must be one of: `comment` or `suggestion`. This is the source of truth for the suggestion classification; agent-produced findings should set `suggestion`. Defaults to `comment` when omitted.
</ParamField>

<ParamField body="suggestion" type="object">
Proposed-change payload for `type: "suggestion"` annotations. Persisted verbatim so reviewers (and your app's accept handler) can round-trip the target and the old/new values. Ignored when `type` is not `suggestion`.

The schema is open — any additional custom fields you include are stored as-is alongside the fields below. `status` is server-owned: any caller-supplied value is dropped and the server stamps `pending` at create time (and `accepted` / `rejected` on the corresponding lifecycle action).
<Expandable title="properties">
<ParamField body="targetId" type="string">
Stable ID of the thing being changed (for example, the record or field ID the suggestion applies to). Your accept handler uses this to locate what to update.
</ParamField>
<ParamField body="targetType" type="string">
Kind of target the suggestion applies to (for example, `custom`, `text`, or a value your app defines).
</ParamField>
<ParamField body="oldValue" type="any">
The value at the time the suggestion was created. Can be any JSON-serializable value.
</ParamField>
<ParamField body="newValue" type="any">
The proposed new value. Can be any JSON-serializable value. Your app writes this into its own state or backend when the suggestion is accepted.
</ParamField>
<ParamField body="summary" type="string">
Optional human-readable summary of the change (for example, `"row.123: 205 → 305"`).
</ParamField>
<ParamField body="driftDetected" type="boolean">
Set to `true` when the live target value at accept time differs from `oldValue`. Informational — it does not block the accept.
</ParamField>
</Expandable>
</ParamField>

<ParamField body="commentType" type="string">
Caller-driven comment classification. Must be one of: `manual` or `chart`. Defaults to `manual` when omitted.

Expand Down Expand Up @@ -573,6 +600,42 @@ To attach a finding from an agent run through your own framework, use `agentSour
}
```

#### Add a suggestion with a proposed-change payload

Set `type: "suggestion"` and attach a `suggestion` object describing what should change. The server persists the payload verbatim and stamps `suggestion.status: "pending"`; any caller-supplied `status` is dropped. Additional custom fields inside `suggestion` are stored as-is.

```JSON
{
"data": {
"organizationId": "acme-corp",
"documentId": "design-mockup-v2",
"commentAnnotations": [
{
"type": "suggestion",
"suggestion": {
"targetId": "row.123",
"targetType": "custom",
"oldValue": { "x": 205 },
"newValue": { "x": 305 },
"summary": "row.123: 205 → 305",
"driftDetected": false,
"myCustomField": "kept as-is"
},
"commentData": [
{
"commentText": "Bump x from 205 to 305 to match the spec.",
"from": {
"userId": "user_sarah_chen",
"name": "Sarah Chen"
}
}
]
}
]
}
}
```

#### Add a private (restricted) comment annotation

Use `visibility` to limit who can see the annotation.
Expand Down
27 changes: 27 additions & 0 deletions ...est-apis/v2/comments-feature/comment-annotations/update-comment-annotations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update Comment Annotations"
description: "Update V2 comment annotations via REST — patch status, priority, assignee, context, or suggestion payload by annotation, location, or user ID."
api: "POST https://api.velt.dev/v2/commentannotations/update"
---

Expand Down Expand Up @@ -146,6 +147,32 @@ Additional filters can be applied using location IDs, annotation IDs, or user ID
</ParamField>
</Expandable>
</ParamField>

<ParamField body="suggestion" type="object">
Proposed-change payload for `type: "suggestion"` annotations. Any fields you send replace the persisted `suggestion` object. Only applied when the target annotation is a suggestion.

The schema is open — additional custom fields are stored as-is. `suggestion.status` is server-owned and cannot be changed here: it is flipped to `accepted` or `rejected` only through the corresponding lifecycle actions (for example, accepting an agent suggestion). Any caller-supplied `status` is ignored.
<Expandable title="properties">
<ParamField body="targetId" type="string">
Stable ID of the thing being changed.
</ParamField>
<ParamField body="targetType" type="string">
Kind of target the suggestion applies to.
</ParamField>
<ParamField body="oldValue" type="any">
The value at the time the suggestion was created.
</ParamField>
<ParamField body="newValue" type="any">
The proposed new value.
</ParamField>
<ParamField body="summary" type="string">
Optional human-readable summary of the change.
</ParamField>
<ParamField body="driftDetected" type="boolean">
Set to `true` when the live target value differs from `oldValue`.
</ParamField>
</Expandable>
</ParamField>
</Expandable>
</ParamField>

Expand Down