Skip to main content

Comments

The comment system provides a review feedback layer on top of any entity in the system. Comments support a resolved/unresolved workflow, allowing reviewers to flag issues and editors to mark them as addressed.

Data model​

FieldTypeDescription
idnumberPrimary key
entityTypestringType of the target entity (episode, scene, scene_block, etc.)
entityIdnumberID of the target entity
textstringComment body
authorIdnumberUser who created the comment
isResolvedbooleanWhether the comment has been resolved
batchIdstring | nullGroups multiple related comments
createdAtDate—

Resolution workflow​

  1. Reviewer creates a comment on any entity
  2. Any team member with access can resolve it via PATCH /comments/:id/resolve
  3. If a resolved comment turns out to be relevant again, it can be unresolved via PATCH /comments/:id/unresolve

Frontend​

Comments are displayed in a side panel in the Studio. The panel filters comments by the currently viewed entity. Resolved comments are visually distinguished and can be toggled on/off.

Permission scopes​

ScopeWhat it guards
COMMENT_CREATECreating a comment

Update, resolve, unresolve, and delete are available to any authenticated user (ownership or admin check applies in the service layer).