Skip to main content

Function: editComment()

editComment(client, props): Promise<{ id: number; text: string; likeCount: number; createdAt: string; moderatedAt: string | null; moderationReason: string | null; createdByUserId: number; createdByName: string; likeId: number | null; }>

Edits an existing comment.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; assetName: string; commentId: number; } = editCommentParamsSchema

Path parameters (orgName, projectName, assetName, commentId)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

params.assetName​

string = assetNameSchema

params.commentId​

number = ...

body​

{ text: string; } = editCommentBodySchema

Request body with updated comment text

body.text​

string = ...

Returns​

Promise<{ id: number; text: string; likeCount: number; createdAt: string; moderatedAt: string | null; moderationReason: string | null; createdByUserId: number; createdByName: string; likeId: number | null; }>

Promise resolving to the updated comment

Operation Id​

edit-comment