Skip to main content

Function: listComments()

listComments(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists comments for an asset.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; assetName: string; } = assetParamsSchema

Path parameters (orgName, projectName, assetName)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

params.assetName​

string = assetNameSchema

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt"; sortDir?: "asc" | "desc"; } = listCommentsQuerySchema

Query parameters (pagination, sorting)

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"createdAt" = ...

query.sortDir?​

"asc" | "desc" = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of comments

Operation Id​

list-comments