[OzzModz] XFRM: Update Comments

Compatible XF 2.x versions

Additional requirements: XenForo 2.2.0+
XenForo Resource Manager 2.2.0+
Standard Library by Xon v1.0.0+

Requirements:

Description:
Allows to comment resource updates.

Features:

New REST API endpoints:
POST resource-update-comments/

Creates a new resource update comment.

Parameters

Input	Type	Description
message	string
author_alert	bool
author_alert_reason	bool
attachment_key	string	API attachment key to upload files. Attachment key context type must be resource_update_comment with context[comment_id] set to this resource update ID.

Response

Output	Description
success	true
comment	Comment

GET resource-update-comments/{id}

Gets information about the specified resource update comment.

Parameters

Input	Type	Description
none

Response

Response	Description
comment	Comment

POST resource-update-comments/{id}

Updates the specified resource update comment.

Parameters

Input	Type	Description
message	string
author_alert	bool
author_alert_reason	bool
attachment_key	string	API attachment key to upload files. Attachment key context type must be resource_update_comment with context[comment_id] set to this resource update ID.

Response

Output	Description
success	true

POST resource-update-comments/{id}/react

Reacts to the specified resource update comment

Parameters

Input	Type	Description
reaction_id	integer	⚠ ID of the reaction to use. Use the current reaction ID to undo.

Response

Output	Type	Description
success	true
action	string	"insert" or "delete" based on whether the reaction was added or removed.

DELETE resource-update-comments/{id}

Deletes the specified resource update comment. Default to soft deletion.

Parameters

Response

Output	Type
success	true

Extended REST API endpoints:
GET resource-updates/{id}

Additional parameters

Input	Type	Description
with_comments	bool	If specified, the response will include a page of comments.

POST resource-updates/{id}

Additional parameters

Input	Type	Description
comment_open	bool	Toggles the ability to comment the resource update

Screenshots:

[OzzModz] XFRM: Update Comments 2.2.0 Patch Level 1