Discussion API Q4 2015 Implementation Status

This describes the status on the master branch, which may not reflect what is deployed on any particular sandbox or in production.

Note on rendered_body

The web front end's JavaScript code attempt to prevent Markdown from rendering anything that is inside a MathJax block (see customwmd.coffee). Additional complexity is added by its attempts to prevent MathJax from rendering anything inside a Markdown code block. Thus, when rendering the string "`foo $bar$ baz`", the backticks are treated as Markdown code delimiters and the dollar signs are not treated specially, while when rendering the string "$foo `bar` baz$", the dollar signs are treated as MathJax delimiters and the backticks are not treated specially. Because math formula rendering is out of scope for Q4 anyway, the current implementation of the rendered_body field (for both threads and comments) does not attempt to prevent MathJax blocks from being rendered by Markdown. Thus, the body "$foo *bar* baz$" will become a rendered_body value of "<p>$foo <em>bar</em> baz$</p>".

Additionally, there are differences between the JavaScript and Python implementations of Markdown. For example, the Python implementation correctly renders in-word emphasis (such as "un*friggin*believable", while the JavaScript implementation leaves the asterisks.

/api/discussion/v1/courses/{course_id}/

Complete

Note: Getting a list of cohort names and ids is p2

/api/discussion/v1/course_topics/{course_id}/

Complete

/api/discussion/v1/threads/

GET

Complete

POST

Complete

Note: Pinning and closing a thread are p2

/api/discussion/v1/threads/{thread_id}/

GET

Complete

Note: GET a single comment is p2

PATCH

Complete

Note: Pinning and closing a thread are p2

DELETE

Complete

/api/discussion/v1/comments/

GET

Complete

POST

Complete

/api/discussion/v1/comments/{comment_id}/

GET

Note: GET a single comment is p2

PATCH

Complete

DELETE

Complete