Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Return comments on changes within a comp review, paginated
findCompReviewComments9 params→ 200400401404
GET
/v1/org/{orgId}/comment/entity/{entityId}
Return comments on a particular entity paginated
findComments6 params→ 200400401404
GET
/v1/org/{orgId}/comment/scenario/{scenarioId}
Return comments on a scenario and the changes within, paginated
findScenarioComments7 params→ 200400401404
GET
/v1/org/{orgId}/comment/{commentId}
Return a particular comment by id
getComment2 params→ 200400404
PATCH
/v1/org/{orgId}/comment/{commentId}
Update a comment
updateComment3 params→ 204400401403404
DELETE
/v1/org/{orgId}/comment/{commentId}
Delete a comment
deleteComment2 params→ 204400401403404
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Comment (19 properties), Attribution (6 properties), CreateComment (5 properties), AccessAction (3 properties). Each schema is shown below with its type and property counts.
ResultsComment
object
3 properties1 required
AccessAction
object
3 properties1 required
ResultsAccess
object
2 properties1 required
CreateComment
object
5 properties3 required
Attribution
object
6 properties
Markup
object
2 properties2 required
Comment
object
19 properties7 required
UpdateComment
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
