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

...