Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

MethodDescriptionAccess
GET

Retrieve a list of comments, ordered by creation date ascending. thread_id must be specified.

Query Parameters:

  • thread_id (String): Retrieve comments within the given thread
  • endorsed (Boolean): Retrieve only endorsed or non-endorsed comments
  • page_size (Integer, must be positive): Number of comments per page
  • page (Integer, must be non-negative): Page number to retrieve
  • mark_as_read (Boolean): Mark the thread the comments are retrieved from as read.
Any role; comments will only be returned if thread group restriction allows
POST

Create a new comment. Parameters as per initializability noted in model.

Required Body Parameters:

  • thread_id
  • raw_body
Any role, subject to thread group restriction, thread closure, and blackouts

...

Code Block
languagejs
titlePATCH /api/discussion/v1/comments/5fe452161cc049dfb3e124c41732beaf/
// Request body
 
{"voted": true}
 
// Response body
 
{
  "id": "5fe452161cc049dfb3e124c41732beaf",
  "parent_id": null,
  "thread_id": "51dfd4e38d9f4f788a0e65c0e9311a55",
  "author": "example-user",
  "created_at": "2015-04-09T17:31:56Z",
  "modified_at": "2015-04-10T14:24:43Z",
  "raw_body": "**Example Comment Body**",
  "rendered_body": "<b>Example Comment Body</b>",
  "endorsed": true,
  "endorsed_by": "example-moderator",
  "endorsed_at": "2015-04-10T14:24:43Z",
  "flagged": false,
  "voted": true,
  "vote_count": 19,
  "children": [],
  "editable_fields": ["flagged", "voted"]
}

Reference Document:

Contradictions in Web and Mobile:

View file
nameDiscussionForum_Web-vs-Mobile.xlsx
height250