update_document_comment
Toggle the resolved state of a root document comment in Polarion. Requires the short comment ID from list_document_comments and works only on top-level comments.
Instructions
Resolve or re-open a single document comment.
Sends PATCH to
/projects/{p}/spaces/{s}/documents/{d}/comments/{commentId}
with {"resolved": <bool>} — the only patchable attribute on a
document comment. Use list_document_comments to discover the
short comment ID (last segment of the full 4-part path).
Root comments only: Polarion accepts this PATCH only on top-level
comments (parent_comment_id is None in
list_document_comments). Calling it on a reply -- any comment
with a non-null parent_comment_id -- returns HTTP 400 "Resolved
field can be set only for root comments" and surfaces as
RuntimeError. Filter for parent_comment_id is None before
calling. There is no server-side workflow to resolve an individual
reply; resolving the root marks the entire thread resolved.
This operation is idempotent: marking a comment resolved twice leaves the same server state as marking it resolved once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Polarion project ID. | |
| space_id | Yes | Space ID (use '_default' for the default space). | |
| document_name | Yes | Document name within ``space_id``. | |
| comment_id | Yes | Short comment ID to update (e.g. 'c42' from ``list_document_comments``). | |
| resolved | Yes | New resolved state for the comment. | |
| dry_run | No | When True, return payload preview without calling Polarion. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| updated | Yes | True on a real PATCH; False on dry-run. | |
| dry_run | Yes | Whether this was a dry-run. | |
| comment_id | Yes | Short comment ID patched (e.g. 'c42'); None on dry-run. | |
| resolved | Yes | The resolved value sent (or that would be sent). | |
| payload_preview | Yes | JSON:API payload sent or previewed; None after real ops. |