Comment Content Revisions: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Display a comment's edit history

Let readers compare previous content with the comment currently displayed.

To display edit history:

1. Read the current comment through the Comments API and retain its ID.
2. When an authorized caller opens edit history, call List Comment Content Revisions with that comment ID and an initial limit of 20.
3. Render each entry's content as Rich Content, with its createdDate.
4. If author.memberId exists, optionally resolve the member's visible profile. Use a generic label for other identity types or unavailable profiles.
5. If pagingMetadata.cursors.next is present, request the next page with the same comment ID and the cursor. Treat the cursor as opaque.
6. Display the current comment separately from the previous versions. Do not duplicate it by assuming the history list includes the current version.

Refresh history after an edit

Keep the displayed comment current while its history updates asynchronously.

To refresh the history:

1. Render the current content from the comment update response.
2. Call List Comment Content Revisions again separately, allowing for asynchronous processing.
3. Replace the displayed history with the refreshed entries. An empty or unchanged history response immediately after an edit isn't a reason to submit the edit again.