Update | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.comments.update("landscapeId", "versionId", "commentId", {
        body: {},
    });
}
main();

{
  "comment": {
    "body": {
      "content": "string",
      "showContentPreview": true,
      "status": "open",
      "type": "question"
    },
    "commit": 1.1,
    "mentionedUserIds": [
      "string"
    ],
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "diagrams": {},
    "id": "string",
    "landscapeId": "string",
    "replyCount": 1.1,
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

commentIdstringRequired

Request

This endpoint expects an object.

bodyobjectOptional

commitdoubleOptional

mentionedUserIdslist of stringsOptional

Response

commentobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error