Skip to content
AveraAveraAvera Documentation

Edit a comment

PATCH
/api/v1/comments/{commentId}
curl --request PATCH \
  --url https://app.avera.io/api/v1/comments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example" }'

Authors edit only their own comments. The edit appends a new comment version rather than mutating the old one, and the anchor item’s lifecycle state rides the permission check, so state-scoped comment rules apply.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
commentId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
body
required
string

Example generated

{
  "body": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
threadId
required
string format: uuid
parentCommentId
string | null format: uuid
depth
required
integer format: int32
body
string | null
contentFormat
required
string
Allowed values: MARKDOWN HTML PLAIN
severity
string | null
Allowed values: CRITICAL MAJOR MINOR OBSERVATION
category
string | null
recommendation
string | null
resolutionState
required
string
Allowed values: OPEN RESOLVED DISMISSED
status
required
string
Allowed values: ACTIVE EDITED DELETED
version
required
integer format: int32
edited
required
boolean
deleted
required
boolean
createdByActor
required
string
Allowed values: USER AI SYSTEM
createdAt
required
string format: date-time
createdBy
required
string format: uuid
editedAt
string | null format: date-time
deletedAt
string | null format: date-time
deletedBy
string | null format: uuid